Local Home SDK Sample

This sample demonstrates integrating a smart home Action with the Local Home SDK. The Local Home SDK allow developers to add a local path to handle smart home intents by running TypeScript (or JavaScript) directly on Google Home smart speakers and Nest smart displays. The sample supports the following protocols along with the companion virtual device:

Device Discovery: UDP, mDNS or UPnP
Control: UDP, TCP, or HTTP

Prerequisites

Node.js LTS 10.16.0+
Firebase CLI

Configure the Actions project

Note: This project uses Cloud Functions for Firebase, which requires you to associate a billing account with your project. Actions projects do not create a billing account by default. See Create a new billing account for more information.

Create a new Smart Home project in the Actions console

Deploy the placeholder smart home provider to Cloud Functions for Firebase using the same Project ID:

npm install --prefix functions/
npm run firebase --prefix functions/ -- use ${PROJECT_ID}
npm run deploy --prefix functions/

In Develop > Actions, set the following configuration values that matches the Cloud Functions for Firebase deployment:
- Fulfillment: https://${REGION}-${PROJECT_ID}.cloudfunctions.net/smarthome
In Develop > Account linking, set the following configuration values:
- Client ID:: placeholder-client-id
- Client secret: placeholder-client-secret
- Authorization URL: https://${REGION}-${PROJECT_ID}.cloudfunctions.net/authorize
- Token URL: https://${REGION}-${PROJECT_ID}.cloudfunctions.net/token
Click Save

Select a discovery protocol

Choose one of the supported the discovery protocols that you would like to test, and create a new scan configuration in the Actions console.

Note: These are the default values used by the virtual device for discovery. If you choose to use different values, you will need to supply those parameters when you set up the virtual device.

In Develop > Actions > Configure local home SDK > Add device scan configuration, Click in New scan config.

UDP

Broadcast address: 255.255.255.255
Discovery packet: A5A5A5A5
Listen port: 3312
Broadcast port: 3311

mDNS

mDNS service name: _sample._tcp.local
Name: .*\._sample\._tcp\.local

Note: The Name attribute value is a regular expression.

UPnP

UPNP service type: urn:sample:service:light:1
Click Save

Select a control protocol

Choose one of the supported control protocols that you would like to test. You will use this value to configure both the cloud fulfillment and the virtual device.

UDP: Send execution commands to the target device as a UDP payload.
TCP: Send execution commands to the target device as a TCP payload.
HTTP: Send execution commands to the target device as an HTTP request.

Choose a device type

The local fulfillment sample supports running as a single end device or a hub/proxy device. This is determined by the number of channels you configure. A device with more than one channel will be treated as a hub by the local fulfillment sample code.

Set up cloud fulfillment

Configure the cloud service to report the correct device SYNC metadata based on your chosen device type and control protocol. Here are some examples for configuring the service for different use cases:

Report a single device (strand1) controlled via UDP commands:

npm run firebase --prefix functions/ -- functions:config:set \
    strand1.leds=16 strand1.channel=1 \
    strand1.control_protocol=UDP
npm run deploy --prefix functions/

Report three individual light strands connected through a proxy (hub1) and controlled via HTTP commands:

npm run firebase --prefix functions/ -- functions:config:set \
    hub1.leds=16 hub1.channel=1,2,3 \
    hub1.control_protocol=HTTP
npm run deploy --prefix functions/

Set up the virtual device

The companion virtual device is a Node.js app that emulates strands of RGB LEDs controllable using the Open Pixel Control protocol and displays the results to the terminal in a colorful way.

Virtual device discovery settings must match the attributes provided in Device Scan Configuration in Develop > Actions > Configure local home SDK.
- If you modify the attributes in your Device Scan Configuration, you must configure the virtual device accordingly. See the virtual device README for more details on configuring the discovery attributes.
Virtual device control protocol should match control_protocol used with functions:config:set when setting up cloud fulfillment.
Configure the device type as end device or hub/proxy based on the number of --channel parameters provided. A device with more than one channel will be treated as a hub.

Note: The virtual device needs to listen on the same local network as the Home device.

Here are some examples for configuring the virtual device for different use cases:

Start the virtual device as a single device (strand1) discovered via UDP broadcast and controlled with UDP commands:

npm install --prefix device/
npm start --prefix device/ -- \
    --device_id strand1 \
    --discovery_protocol UDP \
    --control_protocol UDP \
    --channel 1

Start the virtual device as a hub (hub1) discovered via mDNS and controlling three individual strands with HTTP commands:

npm install --prefix device/
npm start --prefix device/ -- \
    --device_id hub1 \
    --discovery_protocol MDNS \
    --control_protocol HTTP \
    --channel 1 \
    --channel 2 \
    --channel 3

Note: See the virtual device README for more details on the supported configuration options.

Deploy the local execution app

Serve the sample app locally from the same local network as the Home device, or deploy it to a publicly reacheable URL endpoint.

Deploy locally

Start the local development server:
```
npm install --prefix app/
npm start --prefix app/
```
Note: The local development server needs to listen on the same local network as the Home device in order to be able to load the Local Home SDK application.
Go to the smart home project in the Actions console
In Develop > Actions > Configure local home SDK
- Set the testing URL for Chrome to the one displayed in the local development server logs.
- Set the testing URL for Node to the one displayed in the local development server logs.
- Under Add capabilities
  - Check Support local query.
Click Save

Deploy to Firebase Hosting

npm install --prefix app/
npm run build --prefix app/
npm run deploy --prefix app/ -- --project ${FIREBASE_PROJECT_ID}

Go to the smart home project in the Actions console
In Develop > Actions > Configure local home SDK
- Set the testing URL for Chrome to: http://${FIREBASE_PROJECT_ID}.firebaseapp.com/web/index.html
- Set the testing URL for Node to: http://${FIREBASE_PROJECT_ID}.firebaseapp.com/node/bundle.js
- Under Add capabilities
  - Check Support local query.
Click Save

Test the local execution app

In Develop > Invocation, set the Display name for the smart home Action.
In Test, click Start testing
In the Google Home app
- Click the '+' sign
- Select Work with Google
- In the list of providers, select your smart home Action by Display name prefixed with [test]
- Click Link
- Click Complete Account Link
Select the linked devices and click on Add to a room.
Reboot the Google Home Device
Open chrome://inspect
Locate the Local Home SDK application and click inspect to launch the Chrome developer tools.
Try the following query
- Set the light color to magenta
It should display the light strand(s) in a colorful way:
```
◉◉◉◉◉◉◉◉◉◉◉◉◉◉◉◉
```

Troubleshooting

Make sure the Google Home device, the virtual device and your workstation are on the same network.
Make sure to disable any firewall running on your workstation.

Test and Lint

npm test --prefix app/
npm run lint --prefix device/

License

See LICENSE

ruka250/smart-home-local