Table of Contents
Neat Integration
Download PDF1.0 Overview
The pivot Neat Integration integrates Neat devices into the pivot to gain access to 24/7 monitoring from the Neat Platform and combines them with the real-time alerts and advanced analytics to improve service with pivot. With this integration, you can connect an existing Neat account and map the devices into pivot .
2.0 Prerequisite
- Neat Pulse Plus or Pro License
- Neat Organization ID
- Neat API Key
- At least one serial key of a device on the Neat Pro Portal
3.0 Gathering Neat Credentials
The first step is to gather all credentials needed for the integration. Please note that a Neat Pulse Plus or Pro License will be needed with Neat to gain access to the API.
3.1 Organization ID
-
Login into Neat Pulse Pro Portal and click the menu icon located at the top left corner if the menu is not displayed by default.
-
In the menu, click Settings to navigate to the page.
-
Find Organization ID at the top right corner as the screenshot below.
3.2 API Key (Token)
- From the menu, navigate to the Integrations Page.
- Create an API Key with Read Permission for pivot integration and copy the key as it is accessible only one time when it is created as the screenshot below.
-
Please note, if the "Create API Key" is greyed out, please reach out to your Neat Account Manager to get this enabled, or reach out to support@pivotnow.io with your Organization ID from Step 3.1.
-
3.3 Log your Credentials
-
Login pivot platform and navigate to Integrations page to find the Neat Integration card as the screenshot shown.
-
Click on the Connect button to get Neat Integration configuration screen as below.
- Enter the Organization ID and put the API Key as the Authentication Token that were acquired from the Neat Pulse Portal and click on the Connect button.
-
After pivot and Neat integrated successfully, the Neat Integration card will show CONNECTED as below.
3.4 Pairing Devices
To pair your devices within pivot to your Neat Integration, you will need to utilize your device's serial number.
- In Neat Pulse Portal, navigate to the Devices page and drill down to a device to find its Serial Number.
- In pivot Room, click Room List in the menu and navigate to the room where the neat device is located in.
- Click the Device Info tab and click Editing Mode to enter the Serial Number as the screenshot below.
- Repeat these steps for all the devices to monitor.
- Once the devices are mapped successfully between Neat Pulse Portal and pivot, monitoring data from Neat will show up in pivot device cards on the Room Monitoring Data tab as an example below.
3.5 Neat Signals (Determined by Device)
Monitoring data will be refreshed every 5 minutes from the Neat Integration. All the below signals are shared, but is dependent on the device itself, as some devices will not have air quality sensors and will not be able to provide signals such as Humidity or VOC.
Signals | ||
---|---|---|
Bluetooth | Network 1 Link Up | Sensor 1 Co2 |
BYOD Mode | Network 1 Mode | Sensor 1 Humidity |
Connected | Network 1 Name | Sensor 1 Illumination |
Firmware Version | Network 1 Type | Sensor 1 People Count |
Free External Storage | Network 2 Link Up | Sensor 1 VOC |
Free Internal Storage | Network 2 Mode | Sensor 1 VOC Index |
Free System Storage | Network 2 Name | Time Zone |
Latest Firmware Version | Network 2 Type | Total External Storage |
Local IP Address | NTP Server | Total Internal Storage |
Model | Primary Mode | Total System Storage |
Upgrade Status |