Home Automation Server

Description

A simple home automation server built using Nest. It allows you to create WiFi connected push buttons in your home that can switch your Hue lights on and off all within your network.

Installation

Create a .env.local file with the correct vars and

# install dependencies
$ yarn install

How it works

prerequisites:

1. A network with a Hue bridge
2. A valid user and ip of the Hue bridge (more here).

The server will connect to your local Hue Bridge on startup, and will expose the following endpoints:

• (get) /lights -> Show status of all connected lights
• (get) /lights/[name] -> Show status of light with specific name
• (get) /lights/[name]/toggle -> Will switch a light on/off

You can also check out the OpenApi specs on /docs or /docs-json when running the server

Running the app

# development
$ yarn start

# watch mode
$ yarn start:dev

# production mode
$ yarn start:prod

Hygiene

# lint project files with ESLint
$ yarn lint

# check formatting using Prettier
$ yarn format

# validate project files using Typescript
$ yarn validate

Test

# unit tests
$ yarn test

# e2e tests
$ yarn test:e2e

# test coverage
$ yarn test:cov

License

Home Automation Server is HL3-FULL licensed.