Get sensors data via URL through Rest API.
Compatible with Controller firmware version 37.1 or newer.
Download the utility for your OS.
> sudo dpkg -i comino-api.deb
3. After installation check comino-api.service:
> sudo systemctl status comino-api.service
Utility will start automatically.
On successful installation, you will see data from sensors at http://localhost:20000/sensors
On DEBIAN/UBUNTU OS go to /etc/comino-api, open with a text editor: comino.yml
On Windows OS go to \Program Files\Comino-api, open with a text editor: comino.yml
SerialPort:
Name: auto (Do not edit, this is controller virtual port))
Request
PeriodSecs: 5 (Controller polling time in seconds)
HttpServer:
Address: localhost (Address at which the api will be available)
Port: 20000 (Port at which the api will be available)
Change the Address to the IP address of the machine on which the Utility is installed, if you want to get by network. For example, if the Address is 192.168.0.2 then api will be available at http://192.168.0.2:20000/sensors
You can also change the port. For example, if the Port is 8080 then api will be available at http://192.168.0.2:8080/sensors
After any changes in the config file you should restart comino-api
On DEBIAN/UBUNTU OS with command:
sudo systemctl restart comino-api.service
On Windows OS stop it in Task Manager and restart through StartMenu/Comino-api/comino-noconsole.exe
Before connecting to the monitoring system make sure that both your RM machine and the monitoring system are in the same network, i.e. if you’re using the monitoring system in your local network, then you can start connecting. Otherwise, you need to translate the destination IP address of the internal server to public IP address (DNAT).
URL Example
http://192.168.0.34/sensors/P1?limit=1
Response Example (JSON)
{"name":"P1","records":
[{"ID":0,
"CreatedAt":"2021-10-12T12:29:52.384812893+03:00",
"UpdatedAt":"0001-01-01T00:00:00Z",
"DeletedAt":null,
"Value":"4517"}]
}
| SENSOR | DESCRIPTION | API Path |
|---|---|---|
| V | Cooling system power sensor | /sensors/V |
| T0 | STM thermal sensor | /sensors/T0 |
| T1 | Coolant inlet temperature sensor | /sensors/T1 |
| T2 | Coolant outlet temperature sensor | /sensors/T2 |
| T3 | Air inlet temperature sensor | /sensors/T3 |
| T4 | Air outlet temperature sensor | /sensors/T4 |
| T5 | I2C thermal and humidity sensor placed on the controller board | /sensors/T5 |
| T6 | I2C thermal sensor for pumps and fans | /sensors/T6 |
| F1..F6 | Fans sensor | /sensors/F1 |
| P1..P2 | Pumps sensor | /sensors/P1 |
| FLOW | Flow meter | /sensors/flow |
| RH | Humidity sensor placed on the controller board (starting Controller version 38.3) | /sensors/rh |
| LEVEL | Coolant level sensor | /sensors/level |
| PRESSURE | Pressure sensor | /sensors/pressure |