Code Monkey home page Code Monkey logo

light-api's Introduction

Light API

A proxy API for a home automation light control system

Usage

Clone this repository, and then install dependencies using npm install. You can then start the server using npm start. The server will bind to port 3000. All device data is stored in memory and only persists as long as the server is running. If the server is restarted, any changes will be lost.

Documentation

All endpoints return JSON and will have one of the following top level keys:

  • data - The response data for the request
  • errors - An array of error objects

Get all devices

GET /api/v1/device

Example:

fetch('http://localhost:3000/api/v1/device')
	.then((response) => {
		console.log(response.data)
	})

Get a single device

GET /api/v1/device/:id

Example:

fetch('http://localhost:3000/api/v1/device/3')
	.then((response) => {
		console.log(response.data)
	})

Update a single device

PATCH /api/v1/device/:id

Example:

fetch('/api/v1/device/3', {
    method: 'PATCH',
		headers: {
      'content-type': 'application/json'
    },
    body: JSON.stringify({
			data: {
				brightness: 30
			}
		})
  })
  .then(response => response.json())

light-api's People

Contributors

lucianbuzzo avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.