---
description: >-
Display your identifier information, attached call information, and more on
your gaming stream!
---
# 📺 Twitch Bodycam, Bot, & Lighting Integration
 (1) (2).png>)
## What is Sonoran CAD's Livestream Overlay?
Sonoran CAD has a built-in livestream overlay, allowing you to display your live unit information, call information, and more!
Our Twitch bot can also be configured to send out chat messages when data is modified.
## Bodycam Overlay
{% hint style="warning" %}
The free version of the overlay does not include the customizable bodycam asset.\
However, you can still create [custom overlay text](twitch-overlay-and-bot.md#custom-overlay-text) with the free version!
Learn more about the [full version of Sonoran CAD's stream overlay](twitch-overlay-and-bot.md#purchasing-the-overlay)!
The bodycam creates local text files and hosts a local webserver.\
**This requires the** [**desktop** ](../download/)**application to run.**
{% endhint %}
The stream overlay also includes a customizable version of the popular [XION Chase Cam asset](https://github.com/zhivotnoya/XION-ChaseCam).
This allows you to customize a bodycam overlay on your stream, with your real-time unit and call information.
### 1. Set a File Directory
**First, ensure you are using the** [**desktop** ](../download/)**version of Sonoran CAD.** The application has to generate physical files, and host a local webserver to work. This can not be done in a browser.
In the stream overlay, open the txt file directory viewer and select a folder for the text files and bodycam webpage to be generated:
### 2. Configuring the Bodycam Contents
In the livestream overlay config section, expand the `Bodycam` section.
Here, you can enable and customize the data placement and keys just as before with the [customizable text files](twitch-overlay-and-bot.md#3-toggle-and-configure-keys).
* Expand the `Unit Updates` or `Call Updates` Section
* Toggle `ON` the txt file
* `COPY` the field key
* `PASTE` the field key into the bodycam section
* `SAVE` the configuration once complete
You can also optionally specify a different port for the bodycam webpage to run on (`9990` is the default).
.png>)
### 3. Add the Bodycam to OBS
In OBS, add a new "Browser" source and paste the URL listed in the bodycam section.\
By default, this will be `http://localhost:9990`
.png>)
Paste the URL into the browser source and hit OK.
.png>)
### 4. Customize the Size and Placement
You can now customize the size and placement of this browser window in OBS as you normally would.
## Smart Lighting
{% hint style="warning" %}
Due to the nature of most smart bulb manufacturers, our smart lighting integration is at the mercy of their API support.\
\
We can not guarantee that these manufacturers won't change or remove backdoor support to these bulbs in the future.
{% endhint %}
#### [Video Promo and Tutorial](https://www.youtube.com/watch?v=gs6RdZt3mUo)
 (1) (1) (1).png>)
Sonoran CAD allows you to configure in-game events to smart lighting in your own home!
When you toggle your police lights in-game, your room can flash with custom lighting patterns to further immerse and simulate real world lighting.
{% hint style="warning" %}
The smart lighting integration is **not included with the free version** of the Stream Overlay.\
\
[Learn more about the full version of Sonoran CAD's stream overlay.](twitch-overlay-and-bot.md#purchasing-the-overlay)\
\
The smart lighting integration creates local text files and hosts a local webserver.\
**This requires the** [**desktop** ](../download/)**application to run.**
{% endhint %}
{% embed url="https://www.youtube.com/watch?v=gs6RdZt3mUo" %}
Sonoran CAD - Smart Lighting Video
{% endembed %}
### Supported Smart Bulbs
At this time, Sonoran CAD currently supports the following smart bulb types:
#### [Wyze Color](https://wyze.com/wyze-bulb-color.html) (Recommended)
Many of our development team members personally use and recommend these bulbs. Due to the design, these tend to provide the fastest response type with more complex lighting patterns. A 4 pack typically costs \~$40 ($10/bulb).
#### [Philips Hue](https://www.philips-hue.com/en-us/products/smart-light-bulbs)
Philips Hue is significantly more expensive, but is typically the most widely known option. This option will also require the purchase of a Hue bridge/hub. Due to the design, these tend to have a \~10ms+ delay when setting the color of multiple bulbs at a time.
**Therefore, we recommend keeping the `delay` between frames above 500ms when using Philips Hue bulbs.**
#### [Govee](https://us.govee.com/products/wi-fi-led-bulb)
Govee light bulbs are supported via Bluetooth and WiFi.
Bluetooth bulbs are supported, but can have additional time when starting the initial connection. Bluetooth connections can also experience intermittent connection problems. Govee's WiFi bulbs are currently ran through the official API, resulting in rate limitations of 60 calls per minute.
**Therefore, we recommend keeping the `delay` between lighting frames above 1,000ms when using Govee wifi bulbs.**
### 1. Searching for Bulbs
The smart lighting section has multiple `Scenes`
* `Restore`: Set when you are no longer flashing emergency lights, turn signals, etc.
* `Emergency Lights`: While you are in an emergency vehicle with the lights on
* `Panic`: While your panic status is toggled
* `Available`: When your unit status is set to available
* `Unavailable`: When your unit status is set to unavailable
* `Busy`: When your unit status is set to busy
* `Enroute`: When your unit status is set to enroute
* `On Scene`: When your unit status is set to on scene
* `Left Turn Signal`: While your left hand turn signal is on
* `Right Turn Signal`: While your right hand turn signal is on
* `Hazard Lights`: While your hazard lights are on
Expand the `Scene` > `Add Bulb` > `Search for Bulbs` > Select `Wyze` or `Philips Hue`
.png>)
#### Credentials: Wyze
* Username: Email address used to login to your Wyze account
* `Password`: Password used to login to your Wyze account
* `Key ID`: The "Key ID" in the [Wyze API key generator](https://developer-api-console.wyze.com/#/apikey/view)
* `API Key`: The "API Key" in the [Wyze API key generator](https://developer-api-console.wyze.com/#/apikey/view)
#### Credentials: Philips Hue
Your Philips Hue bridge should be automatically discovered by pressing the `Scan` button in Sonoran CAD.
If you are seeing the following error:\
`Error: Unable to find a Hue bridge on the local network.`
You may need to manually enter the bridge's IP address. This is most easily found using the Philips Hue mobile app.
1. Select Settings
2. Network Settings
3. Toggle `DHCP` Off
4. Copy the `IP address` to Sonoran CAD
5. Toggle `DHCP` On
6. Scan for the bridge in Sonoran CAD
.png>)
.png>)
#### Credentials: Govee WiFi
Govee WiFi bulbs are handled via Govee's official API. Note that this does include a rate limit of 60 calls/minute.
**1. Request an API Key**
Using the Govee mobile app navigate to `Account` > `Settings` > `About Us` > `Apply for API Key`
**2. Retrieve your API Key and Search**
Within a few minutes, Govee should email your account API credentials to use. Paste these into Sonoran CAD and search for your Govee WiFi lights.
#### Credentials: Govee Bluetooth
Govee Bulb models only supporting bluetooth can be controlled by Sonoran CAD, as long as your PC supports bluetooth connections. Windows limits this to no more than 5 active bluetooth connections at one time.
**1. Scan for Bluetooth devices**
Sonoran CAD will scan for all locally active Bluetooth devices. Govee bulbs will typically be found with a name format: `WORD_MODELNUMBER_XXXX`.
If your bulb is not discoverable, turn the bulb's power off entirely for \~5 seconds then turn it back on. This should place your bulb into discovery mode.
 (1) (1).png>)
**2. Add the Bulb**
Click on the Bluetooth bulb to add it to your scene, and continue on to building your lighting sequences.
Bluetooth bulbs will have their status listed on the left side. When you click the `Test` button, it may **take up to 60 seconds** for the connection to complete.
 (1) (1).png>)
### 2. Creating Sequences
You can add the desired bulb to your `Scene`. Each `scene` is made up of multiple `frames`.
The example below shows a very simple sequence of two lights switching back and forth between red and blue, with a `delay` of `500ms` between each frame. You can duplicate and create advanced chase sequences, flashes, etc. with several bulbs at a time.
We recommend keeping the delays no shorter than:\
`250ms` for Wyze Color Bulbs\
`500ms` for Philips Hue Bulbs
.png>)
### 3. Testing and Using In-Game
You can press the `Test Scene` button to test the scene with your smart bulbs. Press the `Test Scene` button in the `Restore` scene section to go back to your normal lighting.
#### Local Webserver: In-Game Use
For in-game use, your lights, turn signals, and hazards will automatically run as long as your community has the Sonoran CAD integration framework installed. This utilizes a [local webserver](../api-integration/api-endpoints/local-endpoints/smart-lighting.md) running from your desktop app.
1. If you have modified your Bodycam port from the default `9990`, you will need to update this port in-game as well. Use the `/setlightport ` command in-game to change your port from `9990` to something else.
2. Additionally, ensure you have set your file directory in the credentials section of the stream overlay.
## Configuring the Twitch Bot
Sonoran CAD's stream overlay also comes with a configurable Twitch bot. This bot will send out chat updates when unit or call data is updated.
{% hint style="warning" %}
The Twitch bot is **not included with the free version** of the Stream Overlay.\
\
[Learn more about the full version of Sonoran CAD's stream overlay.](twitch-overlay-and-bot.md#purchasing-the-overlay)
{% endhint %}
### 1. Create a Twitch OAuth Token
Create a new Twitch OAuth token by going to [https://twitchapps.com/tmi/](https://twitchapps.com/tmi/)
### 2. Configure your Twitch Bot Token and Username
Using the overlay in OBS, select the `Twitch Bot` button in the taskbar.\
Paste in your Twitch channel name and OAuth key.
.png>)
Once set, you can press `Test` to display a test message in your Twitch chat.
### 3. Configure the Bot's Event Data
Every piece of unit and call data can be toggled on or off individually.
**It is highly recommended to only toggle on data updates that will not be frequently spammed.** Toggling too many data fields and updating data too quickly may result in **Twitch rate limiting your bot.**
.png>)
### 4. Save and Run
Once you have configured your Twitch Bot's credentials and data fields, press `Save`.
Now, whenever one of those data fields is updated, your Twitch bot will send a chat message.
.gif>)
### Debugging the Twitch Bot
If you're having issues seeing the Twitch bot messages, view the `Twitch Logs` panel in the stream overlay.
This will contain valuable information on the twitch bot's connection, rate limiting, and other errors.
.png>)
If you have too many data fields toggled, and are sending Twitch updates too quickly you may experience rate limiting.
## Custom Overlay Text
The overlay is immensely customizable, allowing you to customize every piece of data displayed.
### 1. Accessing the Overlay Window
The overlay configuration modal can be opened by navigating to `Start Menu` > `System` > `Stream Overlay`. Or, by searching in the start menu.
### 2. Configuring Text File Location
While the Twitch bot can run in a browser instance of Sonoran CAD, the [desktop application](../download/) **is required**, to generate unit/call data txt files.
In the stream overlay, open the txt file directory viewer and select a folder for the text files to be generated:
### 3. Toggle and Configure Keys
{% hint style="warning" %}
The **free version** of the overlay is limited to three (3) data keys.\
Learn more about the [full version of Sonoran CAD's stream overlay](twitch-overlay-and-bot.md#purchasing-the-overlay)!
{% endhint %}
In the `Configuration` tab, toggle on the desired data fields for your unit and dispatch call information.
For every field toggled, a text file will be generated to be viewed in OBS.\
However, we **recommend creating custom text files** to combine multiple data fields in a single text file.
.png>)
#### Data Field Keys:
These can be easily copied from the UI, by pressing the `Copy` button next to the toggled field and pasting into the custom file's key textbox.
| Key | Description |
| ------------------- | ------------------------- |
| {unit\_status} | Unit Status |
| {unit\_location} | Unit Location |
| {unit\_aop} | Unit AOP |
| {unit\_number} | Unit Number |
| {unit\_name} | Unit Name |
| {unit\_agency} | Unit Agency |
| {unit\_department} | Unit Department |
| {unit\_subdivision} | Unit Subdivision |
| {unit\_rank} | Unit Rank |
| {unit\_group} | Unit Group |
| {unit\_panic} | Unit Panic Status |
| {call\_id} | Dispatch Call ID |
| {call\_origin} | Dispatch Call Origin |
| {call\_status} | Dispatch Call Status |
| {call\_priority} | Dispatch Call Priority |
| {call\_block} | Dispatch Call Block |
| {call\_address} | Dispatch Call Address |
| {call\_postal} | Dispatch Call Postal |
| {call\_title} | Dispatch Call Title |
| {call\_code} | Dispatch Call 10-Code |
| {call\_description} | Dispatch Call Description |
### 4. Save your Configuration
Don't forget to save your configuration!
### 5. Configure Data in OBS
In OBS, add a new text source:
.png>)
In the text source properties, select `Read from File` and select one of your generated data key files from the [location specified earlier](twitch-overlay-and-bot.md#2-configuring-text-file-location).
.png>)
.png>)
You can now place the text field anywhere in your OBS stream layout.
You can also customize the fonts, change the background and more!
## Purchasing the Overlay
The free version of the livestream overlay allows anyone to test out the basic functionality. The free version does not allow use of the [Twitch bot](twitch-overlay-and-bot.md#configuring-the-twitch-bot), [bodycam](twitch-overlay-and-bot.md#bodycam-overlay), or [smart lighting integration](twitch-overlay-and-bot.md#smart-lighting) and is locked to a maximum of three custom "data keys".
The full, individual license for Sonoran CAD's livestreaming tools is available for $7.99/mo.
Or, **include the livestreaming tools for your **_**entire**_** community** with [Sonoran One](https://sonoran.one).
Users can purchase a license to the full version in their billing center:
{% content-ref url="../pricing/faq/create-and-manage-a-subscription.md" %}
[create-and-manage-a-subscription.md](../pricing/faq/create-and-manage-a-subscription.md)
{% endcontent-ref %}
###
.png)
.png)
 (1) (1) (1).png)
**2. Retrieve your API Key and Search**
Within a few minutes, Govee should email your account API credentials to use. Paste these into Sonoran CAD and search for your Govee WiFi lights.
#### Credentials: Govee Bluetooth
Govee Bulb models only supporting bluetooth can be controlled by Sonoran CAD, as long as your PC supports bluetooth connections. Windows limits this to no more than 5 active bluetooth connections at one time.
**1. Scan for Bluetooth devices**
Sonoran CAD will scan for all locally active Bluetooth devices. Govee bulbs will typically be found with a name format: `WORD_MODELNUMBER_XXXX`.
If your bulb is not discoverable, turn the bulb's power off entirely for \~5 seconds then turn it back on. This should place your bulb into discovery mode.
 (1) (1).png>)
**2. Add the Bulb**
Click on the Bluetooth bulb to add it to your scene, and continue on to building your lighting sequences.
Bluetooth bulbs will have their status listed on the left side. When you click the `Test` button, it may **take up to 60 seconds** for the connection to complete.
 (1) (1).png>)
### 2. Creating Sequences
You can add the desired bulb to your `Scene`. Each `scene` is made up of multiple `frames`.
The example below shows a very simple sequence of two lights switching back and forth between red and blue, with a `delay` of `500ms` between each frame. You can duplicate and create advanced chase sequences, flashes, etc. with several bulbs at a time.
We recommend keeping the delays no shorter than:\
`250ms` for Wyze Color Bulbs\
`500ms` for Philips Hue Bulbs
.png>)
### 3. Testing and Using In-Game
You can press the `Test Scene` button to test the scene with your smart bulbs. Press the `Test Scene` button in the `Restore` scene section to go back to your normal lighting.
#### Local Webserver: In-Game Use
For in-game use, your lights, turn signals, and hazards will automatically run as long as your community has the Sonoran CAD integration framework installed. This utilizes a [local webserver](../api-integration/api-endpoints/local-endpoints/smart-lighting.md) running from your desktop app.
1. If you have modified your Bodycam port from the default `9990`, you will need to update this port in-game as well. Use the `/setlightport