Содержание

1 iRidium for Nest
2 Description
3 Connection
4 Work in iRidium
- 4.1 Import of Data
  - 4.1.1 Adding Driver Manually
- 4.2 Devices
  - 4.2.1 Thermostat

iRidium for Nest

A set of tools to create interfaces for controlling equipment by Nest.
The driver is only for a server project.

documentation was last updated on 14.5.2021

Description

iRidium for Nest is a set of tools that allows to create an interface to control Nest equipment. A cloud driver interacts with equipment by means of HTTP requests.

Connection

To connect to Nest equipment, do the following:

1 Set a Google account to work with Nest equipment.

2 Create a cloud object for your iRidium pro project.

3 Follow the link log in with your iRidium dealer account.

4 Choose Connect (Set) for the Nest driver.

5 Accept a permission to view and use data about your home from the Google Home app.

6 Choose a required object in iRidium cloud.

7 Click Link. A session for linking can expire and in this case you'll see an error - invalid_grant / Bad Request. Go to point 4 and repeat the following steps.

8 Download a JS file with a driver structure. You can see an a token to connect ot equipment below - OAuth2.0. This token replaces regular authorization.

9 Import the downloaded JS file to iRidium Studio.

10 Download your project with Nest driver to an object in iRidium cloud.

As it is a cloud driver, it works only if a project is started from the cloud.

In case if the authorization token becomes irrelevant:

1 Follow the link.

2 Click Issued tokens.

3 Choose i3pro object with a linked Google account and Nest equipment.

4 Synchronize the token and click Devices and structures

5 Copy the access token.

6 You can update the token in a project via driver settings in iRidium Studio (after it the project must be updated in the cloud) or enter a new token in device settings in the sever web-interface.

Work in iRidium

Create a new project and add Nest Network driver to it with the help of a scanner or entering data manually.

Import of Data

To import commands and feedback channels of equipment from JS project, do the following:

1 Start iRidium studio, create a project and open the Devices panel.

2 Choose Universal import from JS (*.js, *.json) in the Scanner / Import tab and open a project file.

Adding Driver Manually

1 Add the Nest Network driver to a created project in the Devices tab:

2 Click the left mouse button on the driver, add a subdevice (Add subdevice) and enter connection settings to the driver:

Log Level - a level of logging;
Token - an authorization token OAuth2.0 (filled in automatically during import).
Driver Version - a version of the driver.

Name - the name of a subdevice;
Driver Type - a type of driver;
Subdevice ID - ID of a subdevice;
Device Type - a type of subdevice.

Devices

Commands and feedback channels of Nest devices do not have specific settings. They are created when a device is added. Equipment is controlled by means of sending a "value" to a command (Send number, Send string, send value from object).

Thermostat

Command:

Command / feedback channel	Input / expected values	Description
Mode Off	Value	Choice of mode - turn on
Heat	Value	Choice of mode - heating.
Cool	Value	Choice of mode - cooling.
HeatCool	Value	Choice of mode - heating-cooling.
Heat Temperature	9~32	Target heating temperature.
Cool Temperature	9~32	Target cooling temperature
HeatCool Low Temperature	9~32	The lowest temperature limit for the heating-cooling mode.
HeatCool High Temperature	9~32	The highest temperature limit for the heating-cooling mode.
Eco Mode On	Value	Turn on the eco mode.
Eco Mode Off	Value	Turn off the eco mode.
Fan Timer On	Value	Turn on ventilation for a period of time in minutes.
Fan Timer Off	Value	Turn off ventilation.

Feedback:

Command / feedback channel	Input / expected values	Description
Mode	Off, Heat, Cool, HeatCool.	The current mode.
HVAC	"OFF", "HEATING", "COOLING".	The current state of a device.
Eco Mode	0-1	The current eco mode: 1 - manual eco mode is on, 0 - the mode is off.
Eco Heat	Value	Temperature value that makes heating work in the eco mode.
Eco Cool	Value	Temperature value that makes cooling work in the eco mode.
Temperature Heat	9~32	The current target heating temperature.
Temperature Cool	9~32	The current target cooling temperature.
Temperature HeatCool High	9~32	The current required highest temperature limit for the heating-cooling mode.
Temperature HeatCool Low	9~32	The current required lowest temperature limit for the heating-cooling mode.
Connectivity	0-1	Thermostat connection: 1 - on, 0 - off.
Fan Mode	"on / off"	The current state of the ventilation: on - it is on, off - it is off.
Fan Timer Timeout	Value	Time when the ventilation period will be over.
Humidity	0~100	The current humidity (%).
Info	"Thermostat"	The name of the device in the Nest app.
Settings	"CELSIUS"	Temperature measure unit: CELSIUS, FAHRENHEIT.
Ambient Temperature	Value	The current temperature