Overview
Rhombus IoT sensors (E-series) continuously monitor environmental conditions across your facilities. These sensors capture temperature, humidity, indoor air quality (IAQ), CO2 levels, TVOC, PM2.5, and noise levels, reporting data through environmental gateways back to the Rhombus platform. Through the API, you can:- List sensors and retrieve their current readings
- Query historical data for trend analysis and reporting
- Configure sensors by updating descriptions, locations, and camera associations
- Set up climate alert policies that trigger when readings cross defined thresholds
- Monitor gateways that relay data from sensors to the cloud
- Export data as CSV for external analysis tools
Prerequisites
Before you begin, make sure you have:
- A Rhombus API key with sensor permissions (generated in the Rhombus Console under Settings > API)
- At least one E-series environmental sensor deployed and connected to an environmental gateway
- A configured location where your sensors are installed
List All Sensors
Retrieve the current state of every climate sensor in your organization. This returns each sensor’s UUID, name, current readings, battery level, and health status.climateStates array. Key fields for each sensor:
| Field | Type | Description |
|---|---|---|
sensorUuid | string | Unique identifier for the sensor |
name | string | Display name (e.g., “Server Room Sensor”) |
temperatureCelcius | float | Current temperature in Celsius |
humidity | float | Relative humidity percentage |
iaq | float | Indoor Air Quality index |
co2 | float | CO2 level in ppm |
tvoc | float | Total Volatile Organic Compounds |
pm25 | float | PM2.5 particulate matter |
batteryPercent | integer | Battery level (0-100) |
health | string | Sensor health status (GREEN or RED) |
locationUuid | string | Location where the sensor is assigned |
Read Sensor Data
Query historical climate events for a specific sensor over a time range. Each event represents a data point with temperature, humidity, air quality, and other environmental readings.| Field | Type | Description |
|---|---|---|
timestampMs | integer | Event timestamp in epoch milliseconds |
temp | float | Temperature in Celsius at this reading |
humidity | float | Relative humidity percentage |
iaq | float | Indoor Air Quality index |
co2 | float | CO2 concentration |
tvoc | float | Total Volatile Organic Compounds |
pm25 | float | PM2.5 particulate matter |
heatIndexDegF | float | Calculated heat index in Fahrenheit |
The
limit parameter caps the number of events returned. If you need more data points than the limit allows, paginate by adjusting the createdAfterMs and createdBeforeMs window.Configure Sensors
Get Sensor Configuration
Retrieve the full configuration for a specific sensor, including its threshold settings and associated devices.Update Sensor Details
Update a sensor’s description, location assignment, or camera associations. Fields you include with their corresponding*Updated flag set to true will be modified; all others remain unchanged.
Set Up Climate Alerts
Climate policies define threshold rules that trigger alerts when environmental readings go above or below specified values. Create a policy and associate it with sensors to receive notifications.Create a Climate Policy
This example creates a policy that alerts when temperature exceeds 80°F (26.7°C) or drops below 40°F (4.4°C).List Climate Policies
Retrieve all climate policies configured for your organization.Environmental Gateways
Environmental gateways are the hardware hubs that receive data from nearby E-series sensors via Bluetooth and relay it to the Rhombus cloud. Each gateway supports multiple sensors and connects over your network. Use the gateway status endpoint to check connectivity, firmware versions, and which sensors each gateway is serving.Get Gateway Events
Query historical events for a specific gateway, such as connectivity changes and sensor registration.Export Sensor Data
Export climate sensor data as a CSV file for use in spreadsheets, data analysis tools, or compliance reporting. Specify a sensor and time range to download all recorded readings.The export endpoint returns CSV data directly in the response body, not JSON. Use the
-o flag in cURL or write the response text to a file in your application./api/export/environmentalGatewayEvents.
Next Steps
Alarm Monitoring
Set up automated alert responses when sensor thresholds trigger alarms
Webhook Notifications
Receive real-time push notifications when sensor readings cross thresholds