cyanofresh/sh

IoT Core and Dashboard using JS, MQTT, React

Solomaha Home

Currently in ALPHA

Smart Home hub & control panel written using JS, MQTT and React.

Installation

1. Clone repo && cd:

   git clone https://github.com/CyanoFresh/sh
   cd sh
   

2. Install deps

   • production:

     npm ci
     

   • dev:

     npm i
     

3. Copy (if dev) and configure env variables:

   cp .env.example .env

4. If needed configure & build the frontend (in ./frontend folder)

Topic structure: (probably outdated)

Web Panel

user/{ID} - state of all items

Switch

• switch/{ID} - switch current state

• switch/{ID}/set - change switch state:

  {
    "state": true
  }

• switch/{ID}/toggle - toggle switch current state

Variable

• variable/{ID} - current value:

  24.6
  

• variable/{ID}/set - update value [TODO]

RGB

• rgb/{ID} - current state

• rgb/{ID}/set - update state. Example:

  {
      "mode": "color",
      "red": 255,
      "green": 255,
      "blue": 255
  }

  {
      "mode": "rainbow"
  }

Buzzer

• buzzer/{ID}/unlock - unlock command

• buzzer/{ID}/ringing - ringing event (sent from device)

  true

  or:

  false

• buzzer/{ID}/unlocked - unlocked event (sent from device)

Plant

• plant/{ID} - current state

  {
      "moisture": 80
  }

  config update scenario:

  {
      "minMoisture": 80,
      "duration": 2
  }

  can be combined

• plant/{ID}/water - water command

• plant/{ID}/watered - watered event

sh's Issues

Users CRUD

• View
• List
• Delete

Redirect to /login when token is expired

Winston instead of console.log

https://github.com/winstonjs/winston

Wake On Lan module

https://www.npmjs.com/package/node-wol

Support for LAN users

Local API_URL for 127.0.0.1

Migrations for modules

Every module should have a method that returns migrations array for umzug.up() or should have a separate folder for migrations, that should be passed to the umzug

samples:

• https://github.com/sequelize/umzug/blob/master/test/fixtures/index.js

Outdated states after awhile

1. Open on phone
2. Turn off the screen
3. Wait 10+ minutes
4. Open Chrome again: now we have outdated values