Adding Iot to My Home Office Desk Part 2
In part one I discussed the first version/Bluetooth version of my desk upgrade.
In this article, I’ll discuss upgrading the desk to use Google Smart Home so I can control my desk with my voice.
WiFi and Google Smart Home
Adding WiFi to the desk was actually pretty simple. I swapped out the microcontroller from the Nordic NRF52 to an ESP32 since the ESP32 has WiFi built in. Most of the control software was portable since it was written in C++, and both devices could be programmed with Platform.IO and the Arduino libraries, including my own tfmini-s library that I wrote to measure the current height of the desk.
Here is the necessary system architecture to get my desk to talk to Google. Let’s first talk about the interaction between myself and Google.
So, the desk was now WiFi enabled, then it was time to figure out how to interface with Google Smart Home. Google Smart Home is controlled through Smart Home Actions. What is interesting about Smart Home actions is that your service acts as the OAuth2 server and not as a client. Most of the work that I put into the server was related to implementing the OAuth2 Node.js Express app, which will eventually find its way up to Heroku and act as the proxy between Google and my desk.
I was lucky enough that there is a decent implementation of a server through two libraries. The first was the underlying server implementation, called node-oauth2-server and found here. The second was the adapter to hook the library up to express, called express-oauth-server and found here. The example in the GitHub repo for the adapter left a lot to be desired and didn’t really work. It took me a while to reverse engineer how to use the two libraries together. Now I have a decent model that supports registering accounts, refreshing tokens, and validating tokens. The following code snippet shows all the functions that are necessary for the OAuth2 server but you can see the full file here.
1const { Pool } = require("pg");
2const crypto = require("crypto");
3const pool = new Pool({
4 connectionString: process.env.DATABASE_URL
5});
6
7module.exports.pool = pool;
8module.exports.getAccessToken = (bearerToken) => {...};
9module.exports.getClient = (clientId, clientSecret) => {...};
10module.exports.getRefreshToken = (bearerToken) => {...};
11module.exports.getUser = (email, password) => {...};
12module.exports.getUserFromAccessToken = (token) => {...};
13module.exports.getDevicesFromUserId = (userId) => {...};
14module.exports.getDevicesByUserIdAndIds = (userId, deviceIds) => {...};
15module.exports.setDeviceHeight = (userId, deviceId, newCurrentHeight) => {...};
16module.exports.createUser = (email, password) => {...};
17module.exports.saveToken = (token, client, user) => {...};
18module.exports.saveAuthorizationCode = (code, client, user) => {...};
19module.exports.getAuthorizationCode = (code) => {...};
20module.exports.revokeAuthorizationCode = (code) => {...};
21module.exports.revokeToken = (code) => {...};
22
23Next is setting up the actual express app. Below are the endpoints necessary for the OAuth server but you can read the full file here.
24
25const express = require("express");
26const OAuth2Server = require("express-oauth-server");
27const bodyParser = require("body-parser");
28const cookieParser = require("cookie-parser");
29const flash = require("express-flash-2");
30const session = require("express-session");
31const pgSession = require("connect-pg-simple")(session);
32const morgan = require("morgan");
33
34const { google_actions_app } = require("./google_actions");
35const model = require("./model");
36const { getVariablesForAuthorization, getQueryStringForLogin } = require("./util");
37const port = process.env.PORT || 3000;
38
39// Create an Express application.
40const app = express();
41app.set("view engine", "pug");
42app.use(morgan("dev"));
43
44// Add OAuth server.
45app.oauth = new OAuth2Server({
46 model,
47 debug: true,
48});
49
50// Add body parser.
51app.use(bodyParser.urlencoded({ extended: false }));
52app.use(bodyParser.json());
53app.use(express.static("public"));
54
55// initialize cookie-parser to allow us access the cookies stored in the browser.
56app.use(cookieParser(process.env.APP_KEY));
57
58// initialize express-session to allow us track the logged-in user across sessions.
59app.use(session({...}));
60
61app.use(flash());
62
63// This middleware will check if user's cookie is still saved in browser and user is not set, then automatically log the user out.
64// This usually happens when you stop your express server after login, your cookie still remains saved in the browser.
65app.use((req, res, next) => {...});
66
67// Post token.
68app.post("/oauth/token", app.oauth.token());
69
70// Get authorization.
71app.get("/oauth/authorize", (req, res, next) => {...}, app.oauth.authorize({...}));
72
73// Post authorization.
74app.post("/oauth/authorize", function (req, res) {...});
75app.get("/log-in", (req, res) => {...});
76app.post("/log-in", async (req, res) => {...});
77app.get("/log-out", (req, res) => {...});
78app.get("/sign-up", async (req, res) => {...});
79app.post("/sign-up", async (req, res) => {...});
80app.post("/gaction/fulfillment", app.oauth.authenticate(), google_actions_app);
81app.get('/healthz', ((req, res) => {...}));
82app.listen(port, () => {
83 console.log(`Example app listening at port ${port}`);
84});
There is quite a bit of code there but I’ll explain the highlights. The two routes that are used for the OAuth2 server are /oauth/token and /oauth/authorize. These are used for getting a new token or refreshing expired tokens. Next is getting the server to respond to the actual Google Action. You’ll notice that the /gaction/fulfillment endpoint points to a google_actions_app object. Google sends requests to your server in a specific format and provides a library to help you process those requests. Below are the functions necessary to communicate with Google but you can view the entire file here. Finally, there is a /healthz endpoint that I’ll talk about at the end of this article.
The /gaction/fulfillment endpoint uses a middleware called app.oauth.authenticate() and all of my hard work getting the OAuth2 server working was so that this middleware would work. This middleware validates that the Bearer token that Google provides us references a valid user and has not expired. Next, the route sends the request and response to a google_actions_app object. Google sends requests to your server in a specific format and provides a library to help you parse and process those requests. Below are the functions necessary to communicate with Google but you can view the entire file here.
1const { smarthome } = require('actions-on-google');
2const mqtt = require('mqtt');
3const mqtt_client = mqtt.connect(process.env.CLOUDMQTT_URL);
4
5const model = require('./model');
6const { getTokenFromHeader } = require('./util');
7
8mqtt_client.on('connect', () => {
9 console.log('Connected to mqtt');
10});
11
12const updateHeight = {
13 "preset one": (deviceId) => {
14 mqtt_client.publish(`/esp32_iot_desk/${deviceId}/command`, "1");
15 },
16 "preset two": (deviceId) => {
17 mqtt_client.publish(`/esp32_iot_desk/${deviceId}/command`, "2");
18 },
19 "preset three": (deviceId) => {
20 mqtt_client.publish(`/esp32_iot_desk/${deviceId}/command`, "3");
21 },
22};
23
24const google_actions_app = smarthome({...});
25google_actions_app.onSync(async (body, headers) => {...});
26google_actions_app.onQuery(async (body, headers) => {...});
27google_actions_app.onExecute(async (body, headers) => {...});
28module.exports = { google_actions_app };
When you add a Smart Action to your Google account, Google will then perform a sync request. This request lets Google know what devices your account has access to. The next is a query request which is how Google queries your devices to determine their current state.
When you first add a Google Action to your Smart Home account, you’ll notice that Google first sends a sync request and then a query request to get the holistic view of your devices. The final request is an execute request which is how Google tells your devices to actually do things.
Google Smart Home Device Traits
Google uses device traits to control your devices. Google uses these traits to provide UI elements on your Google devices as well as to build communication patterns for voice control. Some of the traits include ColorSetting, Modes, OnOff, and StartStop. It took me a while to decide which trait would work best for my application, but I later selected on Modes.
You can think of modes as a drop down where you can select one of N predefined values, or height presets, in my case. I called my Mode “height” and the possible values are “preset one”, “preset two”, and “preset three”. This allows me to control my desk by saying “Hey Google, set my desk height to preset one,” and Google will send the appropriate execute request to my system. You can read more about Google device traits here.
Off To Production
Finally, Google Smart Home and my computer were communicating. Up until this point, I was using ngrok to run my express server locally. Now that I finally had my server working well enough it was time to make it accessible to Google at all times. This meant using Heroku to host my app. Heroku is a PaaS provider that makes it easy to deploy and manage applications.
One of the major benefits of using Heroku is the add-ons. Heroku add-ons made it super simple to add a CloudMQTT and Postgres server to my application. Another benefit of using Heroku is how simple it is to build and deploy. Heroku automatically detects what code you are using and builds/deploys your code for you. You can find more information about this by reading about Heroku Buildpacks. In my case whenever I push code to the Heroku git remote it will install all of my packages, strip out any development dependencies, and deploy my application all by simply issuing “git push heroku main”.
With a few clicks I had CloudMQTT and Postgres available to my app, and I only needed to use a few environment variables to integrate those services with my application. Everything I’ve done on Heroku was built for free. However, CloudMQTT is a third-party add-on and costs $5/month.
I believe the need for Postgres is self explanatory but CloudMQTT deserves a little more explanation.
From The Internet to a Private Network, The Hard Way
There are a few ways to expose an application, or in my case an IoT device, to the internet. The first is to open a port in my home network to expose the device to the internet. In this case, my Heroku Express app would post a request to my device by using a public IP address. This would require me to have a public static IP address as well as a static IP address for my ESP32. My ESP32 would also have to act as an HTTP server and be listening all the time for instructions from Heroku. This is a lot of overhead for a device that will only receive instructions a few times a day.
The second way is called “hole-punching”. This is how you can use a third-party external server to expose a device to the internet without having to use port-forwarding. Your device basically connects to the server, which establishes an open port. Then, the other service can connect directly to your internal device by retrieving the open port from the external server. Finally, it connects directly to the device using that open port. (This may or may not be entirely correct since I only read part of a paper about it.)
A lot goes into “hole-punching” and I don’t fully understand it. However, if you are curious, there are some interesting articles that explain it more. These are the two articles that I read to better understand “hole-punching”: Wikipedia and a paper from MIT written by Bryan Ford et al.
From The Internet to a Private Network, The IoT Way
I wasn’t very happy with those two solutions. I’ve added many smart devices to my home and I’ve never had to open a port on my router so port forwarding was out. Also, hole-punching seems far more difficult than what I’m looking to implement and is better suited for P2P networks. Through further research I discovered MQTT and found out that it is the protocol for IoT. It has some benefits like low power, configurable resiliency, and it doesn’t require port forwarding. MQTT is a publisher/subscriber protocol which means that the desk is a subscriber of a specific topic and the Heroku app is a publisher to that same topic.
So Google communicates with Heroku, that request is parsed to determine the requested device and what its new state/mode is to be. Then, the Heroku app publishes a message to the CloudMQTT server, deployed as an add-on on Heroku, telling the desk to go to a new preset. Finally, the desk subscribes to a topic and receives the message that the Heroku app published, and the desk adjusts its height to match the request! You’ll notice in the google_actions_app file that there is an updateHeight function which publishes a single number to an MQTT topic for a specific device ID. This is how the Heroku app publishes to MQTT asking the desk to move.
The final step is to receive the message on the ESP32 and move the desk. I’ll show some highlights of the desk code below but the full source code is here.
void setup()
{
Serial.begin(115200);
...
tfminis.begin(&Serial2);
tfminis.setFrameRate(0);
...
state_machine = new StateMachine();
state_machine->begin(*t_desk_height, UP_PWM_CHANNEL, DOWN_PWM_CHANNEL);
setup_wifi();
client.setServer(MQTT_SERVER_DOMAIN, MQTT_SERVER_PORT);
client.setCallback(callback);
...
}
When the desk is booted up we first begin communication between the TFMini-S, which is a distance sensor, to get the current desk height. We then set up a state machine for the actual desk movement. The state machine receives commands through MQTT and then is responsible for aligning the user’s request with the actual height of the desk read from the distance sensor. Finally, we connect to the WiFi network, connect to the MQTT server, and configure the callback for any data we receive on the MQTT topic we are subscribed to. I’ll show the callback function next.
1void callback(char *topic, byte *message, unsigned int length)
2{
3 ...
4
5 String messageTemp;
6
7 for (int i = 0; i < length; i++)
8 {
9 messageTemp += (char)message[i];
10 }
11
12 if (messageTemp == "1") {
13 state_machine->requestStateChange(ADJUST_TO_PRESET_1_HEIGHT_STATE);
14 }
15
16 if (messageTemp == "2") {
17 state_machine->requestStateChange(ADJUST_TO_PRESET_2_HEIGHT_STATE);
18 }
19
20 if (messageTemp == "3") {
21 state_machine->requestStateChange(ADJUST_TO_PRESET_3_HEIGHT_STATE);
22 }
23...
24}
The state machine registers a state change received on the MQTT topic. Then, the state machine in the main loop processes the new state.
1void loop()
2{
3 if (!client.connected())
4 {
5 reconnect();
6 }
7 client.loop();
8 state_machine->processCurrentState();
9}
The main loop does a few things: First, it reconnects to the MQTT server if it wasn’t already connected. Then, it processes any data it received on the subscribed MQTT topic. Finally, it works to put the desk into the correct location according to the state requested over the MQTT topic.
There you have it! My desk is completely voice-controlled and communicating with Google to receive commands!
Final notes
The last endpoint that I didn’t discuss is the /healthz endpoint. This is because Google expects you to respond rather quickly and booting up a Heroku application upon every request wasn’t going to work for me. I set up a ping service to ping the /healthz endpoint every minute to keep the service alive and ready to respond on Heroku. If you plan on doing something like this, then remember that this will use up all of your available free dyno hours. This is fine for now since this is the only app I’m running on Heroku. Alternatively, for $7/month, you can upgrade to Heroku’s Hobby plan, which keeps the app “alive”.
Conclusion
Building an IoT device has a lot of overhead to get started. I constructed the actual hardware, built the control circuitry, set up an MQTT server, built an Express OAuth2 server, and learned to interface with Google Smart Home through Actions. The initial overhead was a lot but I feel like I’ve accomplished a lot as well! Not to mention that the MQTT server, Express OAuth2 app server, and Google Smart Home Actions are all reusable. I’m really interested in the Smart Home space, and I may try to expand my IoT devices repertoire to include some sensors that can monitor various things around my house and report back over MQTT. Soil monitor sensors, temperature sensors, and light sensors will be a lot of fun to monitor and analyze.
Where to Go Next
The way I’m measuring the height of the desk right now is flakey at best. I’m using an IR distance sensor called a TFMini-S which mostly works. I’ve noticed that the height of the desk changes a little bit throughout the day as the ambient lighting of the room changes. I’ve ordered a rotary encoder so I can count the number of turns the rod running through the desk actually makes. This should give me much more accurate movements any time of the day. I also have access to a server that I host out of a basement somewhere that I might investigate running my own Mosquitto MQTT server, Node-RED server, and Express OAuth2 app if I’m feeling up to hosting something myself. Finally, right now all the electronics are just out in the open on my desk. I plan to enclose those so everything looks nice and tidy!
Thanks for reading! Here are all the links from above for easy reference.
Published To
- https://dzone.com/articles/adding-iot-to-my-home-office-desk-part-2
- https://brennonloveless.medium.com/adding-iot-to-my-home-office-desk-part-2-3819a0a9c065
- https://hackernoon.com/adding-iot-to-my-home-office-desk-part-2-bn183wj6
- https://dev.to/bloveless/adding-iot-to-my-home-office-desk-part-2-2fcd