brianping7/scorpian

This project will integrate your home devices with Voice Control solution.

Welcome to Scorpian Project

This project is aim to integrate the home smart devices with voice control solution. The project is still in initial phase, your comments and advices are fully welcomed. Current Scorpian Project supports the following devices:

• Smart Televison
  • Sony
• Smart Home Device
  • MiHome (Xiao Mi)
    • Vacuum

Scorpian Project has been tested with Amazon Alexa.

Installation

Use npm to install the project.

cd ./scorpius
npm install

There is a docker image will prepare the running environment you may want to leverage Scorpian Docker.

Configure

The folder config includes all the config file you may want to change. It will help you to config the device or the serial actions you want the device to act.

• Runtime Config: File runtime.conf.js includes all the runtime config like port, device type and etc.

  "Port": 7007,            // The port the program will listen in order to get instruction
  "Delimiter": '=',        // You may want to use **"Action=Role"** to make **Role** to do **Action**
  "MsgPreFix": "/:intent", // The prefix of your request string
  "SceneRole": "Jarvis",   // The Role who will run the scene (a serial actions)

• Device Config: File device.conf.js includes the device information like IP, type and etc.

"Friday": {                // You may want give your device a nick name.
    "ip": "192.168.1.2",   // The IP address
    "token": "12345",      // The token of the device if any
    "type" : "tv",         // The device type
    "brand": "sony"        // The brand of the device
  },

• Scene Config: File scene.conf.js includes all scene you want to support.

"leave": {                 // The scene name, like you are leaving home
    "actions": [           
      {
        "device": "dummy", // The device nick name
        "action": "stop"   // The action you want the device to act.
      },
      {
        "device": "friday",
        "action": "stop"
      }
    ],
  }

Usage

Use node or nodejs to run the program.

node index.js

You should see the program is listening the PORT you set in config file.

Thanks

Most plugin parts are customized from other project.

• alanreid/bravia - For the Sony Smart TV support.
• aholstenson/miio - For the MiHome plugin support.

Support or Contact

Having trouble with project? Check out our Issues Support and we’ll help you sort it out.