SiteSync Docs

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== SiteSync Ignition Module FAQ ======

The SiteSync Ignition Module can be used in many ways. If you aren't sure how to start, take a look at some of the most frequently asked questions about using the module.

===== How do I add a sensor via QR scan? ======

If your device has a QR code, you can add it to the SiteSync LoRaWAN module via QR scan. Devices can be added in this way using the Ignition Perspective mobile app, available on the App Store or the Play Store for mobile devices. After launching your project from the app, choose “Add or Manage Devics” from the home page, or choose the “Devices” icon in your navbar. This page will display a list of your devices as well as some summary information about their connection status. Choose the button labeled “Activate Device” to add a new device using Over-the-Air Activation. 
 

On perspective sessions launched in a web browser, this page can be used to add sensors manually, using the device EUI, device type, app key, and app EUI/join EUI generated for your LoRaWAN device. On the mobile app, devices purchased through SiteSync can also be added using the “Launch QR Scanner” button. Simply point the camera at the QR Code for your device, and it will automatically detect the device EUI, device type, app key, and app EUI/join EUI. If the scan results look correct, tap the “Done” button to fill the corresponding fields of the “add device” page with the scanned information. You will still be able to edit this information, as well as add a device name, note some device details, select a tag provider and tag path for the device, and add a location and picture of installation for the device. 
 
===== How do I add a sensor manually? =====

Sensors can be added manually in the SiteSync LoRaWAN module in any perspective session. After launching your project, choose “Add or Manage Devics” from the home page, or choose the “Devices” icon in your navbar.  
This page will display a list of your devices as well as some summary information about their connection status. Choose the button labeled “Activate Device” to add a new device using Over-the-Air Activation.  
On this page, there will be a number of form entry fields that are used for configuring your device.  
The device requires a 32 character app key, a 16 character device EUI, and a sensor type chosen from the dropdown menu. Some devices also require an app EUI, sometimes called a join EUI, as well. The “device details” field saves notes about the device in the module, for later reference. This field does not affect module function. The device coordinates field allows you to add a location for your sensor to place it on a map within the module. This map can be found by toggling the “Map view” switch on the devices page. The tag provider and tag path fields allow you to configure where the tags for device check-in data are stored. The “Upload Picture of Install“ button allows you to optionally add a photo of the device installation to save in the module. When all fields are filled out, choose the “Save” button at the bottom of the page to finish adding your sensor.
 
After successfully adding the device, a confirmation pop-up will appear. If you are missing information, an error message will appear instead.
 
 
===== How do I bulk upload sensors? =====
 
If you have many sensors that you want to add at once, you can format and upload a .xlsx file with multiple sensor configurations. After launching your project, choose “Add or Manage Devices” from the home page, or choose the “Devices” icon in your navbar. To bulk upload, choose the button labeled “Bulk Device Upload”.
 
This will open a pop-up where you can either upload your pre-formatted .xlsx file with the device configurations you want to add or download a template file to help format the bulk device upload. The required fields are a 16-character dev_eui, a 16-character join_eui (sometimes called an app eui), a 32-character app key, a device name, a device type, and a tag path. 

You can optionally include a description, hardware version, firmware version, location description, and equipment description in your bulk upload as well. When you have your formatted .xslx file with the sensors for bulk upload, you can save and upload the .xlsx file in the bulk upload pop-up. Each device will show an upload status after the upload completes, so you can troubleshoot any devices that failed to upload.
 
 
===== How do I change details on a device I've already added? =====

After launching the project and choosing the “Add or Manage Devices” button or the “Devices” icon from the navbar, you can review a list of all your added devices. From this list, you can double-click a device to review its details and change its saved name, description, tag provider, tag path, or location data.  
After making your changes, click the “Save Changes” button to apply. You can also change the device image. To do so, go to its details page and choose the “Image” Tab. Click the cloud-shaped button and upload a new image to replace the image saved to your device.  
You can remove a device from the device details tab. At the bottom of the details list, there is a button labeled “Delete Device”. If you click it, a confirmation pop-up will appear to warn you that you are about to delete the device and all tags associated with it. To cancel, click “Go Back”, and to proceed, click “Delete”.
 
===== How do I troubleshoot a device issue? =====

If you need to troubleshoot a device issue, there are two ways of doing so. 

To troubleshoot which device is experiencing an issue, the “Device Manager” page provides a status for each device added to the module, and a count of how many devices are operating under each status. To access the Device Manager page, launch your project and choose either the “Add or Manage Devices” button from the home screen, or the “Devices” icon from the navbar. From here, you will see a list of all devices, and a status icon indicating whether the device is operational, has never checked in, or is experiencing an error. 
 

To list all devices of a particular status, click the box corresponding to that status at the top of the page, under the navbar.
 
If you know which device is experiencing an error, you can troubleshoot further by double-clicking the device in the device list to open the device details page.
From here, choose the “Diagnostics” tab to see an overview of the device connection path, and a device status message. This information can be helpful in determining what steps are necessary to continue troubleshooting the device.