Got questions about how to use Spoke Zone? Find all the answers you need here!

Links to the docs for each feature are found below each heading for more info on those specific features.

Click here for more info on devices.

If you can't see your device, it might be disabled. Here's how to check:

1. Navigate to the Devices page.
2. Select Disabled in the Status filter on the left to show all disabled devices.
3. If needed, find your device using the search bar in the top right.

1. Navigate to the Devices page.
2. Double click on your device to open the device editor.
3. Click on the section in the section selector.
4. Assign a SIM card by entering the ICCID.

1. Navigate to the Home page.
2. Search for your device in the overlay on the left (you can also find it in the Devices page if you don't know its identifier).
3. Click on your device.
   • An overlay with info about the device, including when it was last online, will appear at the bottom right corner of your screen.

Click here for more info on CAN databases.

1. Navigate to the Models page.
2. Double click on your model to open the model editor.
3. Click on the section in the section selector.
4. Click the button and select your file.

Click here for more info on dashboard setup or here for more info on dashboard widgets.

If your dashboard isn't displaying live data when the datasources are online:

1. Navigate to your model editor from the Models page.
2. Click on the section in the section selector.
3. Ensure your CAN database is uploaded and set to Active.
4. If the issue persists:
   1. Click the button for the relevant database.
   2. Make sure each message has Send over MQTT checked.

1. Click the button at the top right of the dashboard page.
   • All devices currently included on the dashboard will be displayed under the Datasources heading.
   • Datasources are used to supply data to your dashboard widgets.
2. Click the button and follow the prompts.
   • The "name" of the datasource is simply an identifier for that specific dashboard and doesn't have to match the device's real name.
3. Once you are finished adding datasources, make sure to click the button to save your changes.

Check the status icon at the top right:

• Live: Live data is coming in from at least one of the devices on the dashboard.
• Loading: No live data currently, but there was some in the last 30 seconds. Hopefully the device will reconnect.
• Offline: No device on the dashboard is sending live data.

1. Click the button at the top right of the dashboard page.
2. Click on the widget's button.
3. For any calculated settings that you want to use custom logic for, click the button on the right. Use JavaScript logic to specify what the widget shows.

For example, if you want to show data for topic speed but want it converted to KPH, you would use

Or, if you wanted to change the color of the text (using a calculated setting) based on speed, you might use

Click here for more info on custom widgets.

1. Navigate to the Custom Widgets page and click the button.
2. Edit the JQuery code for your widget in the section.
   • Handle signals, send commands, do UI logic
   • Create variables, functions, signal handlers, new HTML elements, etc.
3. Add configurations for the widget in the section.
   • Settings allow you to use multiple copies of one custom widget for various purposes.
   • For example, you can create a Datasource setting to specify which datasource of a dashboard you want to subscribe/publish to.
4. Add CSS styles for the widget's UI in the section.

Click here for more info on reports.

All devices currently included in the report will be displayed in the Devices overlay on the right of the report page.

Click the button and check all the devices you want to see data for in the report.

Go into the report page and click the button in the Action overlay at the top left.

To add messages to a chart:

1. In the report page, click the button in the toolbar at the top of the chart.
2. Click the button and select the signals you want to be shown in the chart.
3. Click the button to save your changes and return to the main page.

If no signals show up in the dialog, it is possible your CAN database isn't uploaded, or isn't active, or both. To check:

1. Navigate to your model from the Models page.
2. Click on in the selector on the left.
3. The trace file won't have been parsed correctly if the CAN database was not active when the file was uploaded.

Click here for more info on alerts.

1. Navigate to your alert's editor from the Alerts page.
2. Click on the section in the section selector.
3. Check each of the devices you want to configure the alert for.

1. In the alert editor, click the section in the section selector.
2. Click the button to add logic based on CAN signals, or the button to specify the time window each day when the alert is allowed to be sent.

You can receive alerts via either email or text:

1. In the alert editor, click the section in the section selector.
2. Click the button.
   • You will need to create two separate actions if you want to receive alerts in both email and text form.
3. When setting up the body of the email/text, keep in mind you can insert values from CAN signals.
   • See this page for details.

Click here for more info on geo fences.

You can receive geo fence alerts via either email or text:

1. In the geo fence editor, click the section in the section selector.
2. Click the button. You will need to create two separate actions if you want to receive alerts in both email and text form.
3. You can choose to receive an alert when the device
   • Enters the fence (goes inside the shape(s) you drew),
   • Exits the fence (goes outside the shape(s) you drew),
   • Or both.

1. In the geo fence editor, click the section in the section selector.
2. Use the buttons in the small overlay at the top of the map to create new shapes.
   • You can quickly create rectangles and circles, or you can create custom shapes with the Draw a shape button.
   • Once you click the button, you can then repeatedly click on the map to place the points, and then click on the first point again to complete the shape.

Click here for more info on modules.

• Modules are used to assign OTA software to devices for a given model.
• Most models will have only one module, but some models have multiple modules for various hardware components that each require different OTA software.
  • For example, if a devices have a display connected to two CAN controllers that each have their own software, the model might have display, can-controller1, and can-controller2 modules.

1. Navigate to your model editor from the Models page.
2. Click on the section in the section selector.
3. Click the button for the desired module.
4. Click the button in the top right to add a new OTA release.
5. Enter the version number, notes, and date (optional), upload the release file, activate the release, and click to save.

Click here for more info on settings.

1. Navigate to the Settings page and click the section in the section selector.
2. Click the button on the logo and/or icon and select a file.

In the section of the Settings page, click on the Primary Color button to change the theme color.

Click here for more info on the important URLs used in the Spoke Zone platform.