Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/create1st/openhabot

NodeJS, Wit.AI, OpenHab
https://github.com/create1st/openhabot

Last synced: about 7 hours ago
JSON representation

NodeJS, Wit.AI, OpenHab

Host: GitHub
URL: https://github.com/create1st/openhabot
Owner: create1st
License: apache-2.0
Created: 2019-02-13T16:42:05.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2022-12-09T12:47:21.000Z (almost 2 years ago)
Last Synced: 2024-11-07T13:41:07.972Z (13 days ago)
Language: JavaScript
Homepage:
Size: 151 KB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# OpenHaBot
This is NodeJS based implementation of openHAB Bot for Facebook Messenger

## Installation
```
sudo npm install express body-parser node-wit http-status-codes lodash loglevel web-audio-api audiobuffer-to-wav --save

git clone https://github.com/create1st/openhabot
```

## Configuration

* Create a new Facebook Page for your Bot https://www.facebook.com/pages/create
* Create a new Facebook App for your Bot https://developers.facebook.com/quickstarts/?platform=web You have to set up Privacy Policy and provide the URL. You can have one for free from https://www.iubenda.com
* In Facebook App add a product *Messanger* for which you will create a *webhook* once the bot is started for a very first time
* In Facebook App go to *Advanced* and set *Require App Secret*
* Set up a secured ssh tunnel for your Facebook webhook. You can use http://serveo.net/ Check their web site for more details how to configure your own domain in a secure way. You can use http://ngrok.com or other alternatives as well

```
$ ./ssh -R mydomain:80:localhost:1337 serveo.net
```

* Create *config.json*
* **FB_PAGE_ACCESS_TOKEN** - On Facebook application page: **Products** -> **Messenger** -> **Token Generation** -> (Select a page for you application or create a new one) -> **generate token**
* **FB_APPLICATION_SECRET** - On Facebook application page: **Settings** -> **Basic** -> **App Secret** (push the show button)
* **USER_RANDOM_VERIFICATION_TOKEN** - Type whatever you want
* **WIT_AI_ACCESS_TOKEN** - On Wit.Ai application page: **Settings** -> **API Details** -> **Server Access Token**
* **authorizedSenders** - Your facebook id and ids of other user who shall be peritted to execute commands. You can leave it empty and that would mean anybody is going to access the page. Since the app is by default set in development mode this means only you will have the access to it. However if you leave it empty you are not going to receive any notifications. If you do not know what is your Facebook id then put here anything and on first chat the system will respond with it and message that you are not authorized.
* **confidenceLevel** - depending on quality of your rules and particular language gramma complexity Wit.Ai can guess the entities with some confidence. The confidence level configured in config acts as a threshold under which we consider that the Wit.Ai evaluation was correct or not.
* **language** - this one is important as you need to have a dictionary json file suffixed with language id you have specified here
```json
{
"webhookPort": "1337",
"accessToken": "FB_PAGE_ACCESS_TOKEN",
"verifyToken": "USER_RANDOM_VERIFICATION_TOKEN",
"appSecret": "FB_APPLICATION_SECRET",
"witAccessToken": "WIT_AI_ACCESS_TOKEN",
"authorizedSenders": ["YOUR_FACEBOOK_PAGE_NUMBER_ID"],
"confidenceLevel": "0.77",
"language": "en",
"openHabRestUri": "http://127.0.0.1:8080/rest",
"openHabHttpBindingPort": "1338",
"logFile": "/var/log/openhabot.log"
}
```
* Create Wit.Ai account
* Create Wit.Ai entities following Wit.Ai manual at https://wit.ai/docs/quickstart (you can find my entities created for polish language at https://wit.ai/create1st/OpenHaBot/entities). Entities does specify the group, e.g. *openhab_locations* and entity value does specify particular real world object, e.g. *sleeping_room*. You may decide to use *openhab_locations* and *openhab_settings* for entities or decide to use anything you like, however you have to use *set* and *get* for definition of the keywords related to querying item value and setting a new one. Setting a value is limited to the numbers which shall be mapped to *wit/number*. All the states related to toggling a switch or execution of a command are mapped to *openhab_state* entity. To have better understanding check next section related to *sitemap.json* definition
* Create *sitemap.json* to map the items you want to control with OpenHaBot. The mapping has to follow the schema: **openhab_locations** or **openhab_thing** -> Wit.Ai value -> **openhab_settings** -> Wit.Ai value -> **openhab_operations** -> Wit.Ai value (get, set or command) which maps to particular OpenHab item.
* **get** shall be mapped to particular item value in Wit.Ai. This is to read item state, e.g. **what is the temperature in the living room?**
* **set** shall be mapped to particular item value in Wit.Ai. This is to set **numeric** item state, **set the temperature in the living room to 23 degrees**
* Setting the state of items of type string, switch, etc. is achieved via **command** which does not have direct mapping in Wit.Ai. What is mapped is the location and/or thing symbolic name, the operation (e.g. "cleaning") and desired state (e.g. start/stop/on/off). It is imporatant to notice that some particular states which are defined by vendor do not match language semantics, e.g. Neato robots have command channel which do accepts states: *clean*, *stop*, *pause*, *resume*, *dock*. In this example we do have two language specific issues. First is state *clean* which for "cleaning" operation means nothing. We do not want to have commands like **neato, clean cleaning**. Meaningful from language point of view are commands like: **neato, start cleaning**, **neato, stop cleaning**, etc. So first thing we need to do is to create mappings which will recognize *start* and transforms it to *clean* which is understood by OpenHab Neato binding. Second issue with Neato accepted states is state *dock*. It is unrelated to cleaning operation. We do not want to have constructions like **neato, clean the dock**. Therefore we should create separate operation "return" for the same command itemwhich will accept the state *dock*, so we can say **neato, return to the dock**. To ilustrate the problem and possible solution check Alexa skills and command examples https://www.amazon.com/Neato-Robotics/dp/B01MXI58Y7?tag=hawk-future-20&ascsubtag=tomsguide
Please check also sample *sitemap.json*
```json
{
"openhab_locations" : {
"workplace_room": {
"openhab_settings": {
"temperature": {
"openhab_operations": {
"set": "zwave_device_dev_node2_thermostat_setpoint_heating"
}
}
}
},
"bathroom": {
"openhab_settings": {
"temperature": {
"openhab_operations": {
"set": "zwave_device_dev_node3_thermostat_setpoint_heating"
}
}
}
},
"sleeping_room": {
"openhab_settings": {
"temperature": {
"openhab_operations": {
"get": {
"openhab_data_item": {
"graph": "grafana_temperature_measure_sypialnia_image"
},
"default": "mihome_sensor_ht_node1_temperature"
},
"set": "zwave_device_dev_node4_thermostat_setpoint_heating"
}
},
"humidity": {
"openhab_operations": {
"get": "mihome_sensor_ht_node1_humidity"
}
}
}
},
"living_room": {
"openhab_settings": {
"temperature": {
"openhab_operations": {
"get": {
"openhab_data_item": {
"graph": "grafana_temperature_measure_salon_image"
},
"default": "mihome_sensor_ht_node2_temperature"
},
"set": "zwave_device_dev_node5_thermostat_setpoint_heating"
}
},
"humidity": {
"openhab_operations": {
"get": "mihome_sensor_ht_node2_humidity"
}
}
}
},
"studio": {
"openhab_settings": {
"temperature": {
"openhab_operations": {
"set": "zwave_device_dev_node6_thermostat_setpoint_heating"
}
}
}
},
"corridor": {
"openhab_settings": {
"light": {
"command": "mihome_gateway_dev_lightSwitch",
"values": ["on", "off"]
}
}
}
},
"openhab_thing": {
"neato": {
"openhab_operations": {
"cleaning": {
"command": "neato_vacuumcleaner_robot_command",
"values": ["start", "stop", "pause", "resume"],
"mappings": {
"start": "clean"
}
},
"return": {
"command": "neato_vacuumcleaner_robot_command",
"values": ["dock"]
}
}
},
"OpenHaBot": {
"openhab_operations": {
"update": {
"command": "bot_update_config_command",
"values": ["config"],
"mappings": {
"config": "on"
}
}
}
},
"openHAB": {
"openhab_operations": {
"update": {
"command": "system_update_config_command",
"values": ["config"],
"mappings": {
"config": "on"
}
}
}
}
}
}
```
Keys in json are Wit.Ai entities/roles which do structure a look up path for OpenHab item. Example outcome from Wit.Ai look up can be like:

```javascript
{ openhab_operations:
[ { confidence: 0.99708430836861, value: 'get', type: 'value' },
[length]: 1 ],
openhab_data_item:
[ { confidence: 0.98959600983719, value: 'graph', type: 'value' },
[length]: 1 ],
openhab_settings:
[ { confidence: 0.94957579274518,
value: 'temperature',
type: 'value' },
[length]: 1 ],
openhab_locations:
[ { confidence: 0.9959712447152,
value: 'living_room',
type: 'value' },
[length]: 1 ] }
```

* Update your \*.items files and add HTTP Binding channel (Http Binding has to be installed on OpenHab) for the items you want to be notified. It is important to notice that path in HTTP binding URI must match the item name, e.g. item with name **neato_vacuumcleaner_neato_error** uses the channel http\://127.0.0.1:1338/rest/items/**neato_vacuumcleaner_neato_error**/state/?state=%2$s
```
Group Vacuum "Odkurzacz" [ "Vacuum" ]
String neato_vacuumcleaner_neato_state "Bobik status" (Vacuum) {channel="neato:vacuumcleaner:neato:state",http=">[CHANGED:POST:http://127.0.0.1:1338/rest/items/neato_vacuumcleaner_neato_state/state/?state=%2$s]"}
String neato_vacuumcleaner_neato_error "Bobik error" (Vacuum) {channel="neato:vacuumcleaner:neato:error",http=">[CHANGED:POST:http://127.0.0.1:1338/rest/items/neato_vacuumcleaner_neato_error/state/?state=%2$s]"}
Switch neato_vacuumcleaner_neato_is_docked "Bobik docked" (Vacuum) {channel="neato:vacuumcleaner:neato:is-docked",http=">[CHANGED:POST:http://127.0.0.1:1338/rest/items/neato_vacuumcleaner_neato_is_docked/state/?state=%2$s]"}
String neato_vacuumcleaner_neato_command "Bobik command" (Vacuum) {channel="neato:vacuumcleaner:neato:command"}
```

* Create *dictionary_{language_id}.json* for your language
```json
{
"error": {
"unauthorized": "You are not authorized to use this service. Your id %s has been recorded.",
"unsupported_message_type": "I don't understand. How can I help you?",
"openhab_call_failed": "OpenHab error: %s",
"wit_call_failed": "Wit.Ai error: %s"
},
"message": {
"unrecognized_command": "I don't understand. Please be more precise",
"get_value": "The value is %s",
"get_value_undefined": "The value is undefined",
"set_value": "Cofirmed",
"update": "%s has changed the state to %s"
},
"state": {
"OFFLINE": "offline",
"ERROR": "error",
"BUSY": "busy",
"IDLE": "idle",
"ON": "on",
"OFF": "off"
}
}
```

* Start the OpenHaBot application
```
node .
```
* Create Facebook Webhook. **Products** -> **Webhooks** -> **Edit Subscription**. Use your serveo.com webhook tunnel address and **Verify Token** which you have specified in *config.json* as **USER_RANDOM_VERIFICATION_TOKEN** and *Select a page to subscribe your webhook to the page events*

* Optionally you can configure OpenHaBot to start at system boot
* Create a startup script in /etc/init.d
* Updare rc.d
```
sudo update-rc.d defaults
```