Smart City Template

The smart city template is a report template that presents all significant air quality and environment parameters useful for monitoring and understanding the status of the environment. Sensor values that are polled by the sensors connected to your device will then be mapped out to this template. Only the properties of the sensors connected to your device will have values, while the rest will just be blank or null.

The JSON payload that the Push API sends every interval uses this template, as well as the JSON file that can be sourced from the GET API “/reports” endpoint. As you may noticed, the arrangement and naming of properties are the same with the report’s columns that can be found in the report page (see Reports page for details). That is because all of them are using the same smart city template.

Available Parameters / Properties:

Installation / Base Unit Details:

installation_id

<string> The installation id assigned to the device.

installation_name

<string> The installation name assigned to the device.

installation_site

<string> The installation site assigned to the device. Note: this is not yet configurable from the portal

bu_serial

<string> The serial of the device.

bu_endpoint

<string> The endpoint name of the device registered in the LwM2M server.

gps_mode

<number> The GPS mode activated in the device. Note: this is not yet configurable from the portal

polling_interval

<number> The polling interval set in the device’s settings. Note: the value is not yet available in the report.

posting_interval

<number> The posting interval set in the device’s settings. Note: this is not yet configurable from the portal.

Sensor and health data:

dataset_id

<number> The unique identifier / counter assigned to each payload. This is useful for tracing and debugging data gaps. Note: this feature is not yet available.

timestamp

<number> The timestamp when the sensor values were polled.

battery

<number> The device’s battery percentage.

gps_duration_fix

<number> Refers to how long a GPS fix was obtained.

gps_latitude

<number> GPS latitude

gps_longitude

<number> GPS Longitude

gps_speed

<number>Refers to how fast the vehicle was moving with the device on it. Applicable only if the device is moving or positioned on top of a mobile unit.

gps_accuracy

<number> Refers to how accurate the device position is in terms of percentage.

pm0_1

<number> Level of particulate matter 0.1 measured by the air quality sensor.
unit of measurement: µg/m³

pm0_3

<number> Level of particulate matter 0.3 measured by the air quality sensor.
unit of measurement: µg/m³

pm0_5

<number> Level of particulate matter 0.5 measured by the air quality sensor.
unit of measurement: µg/m³

pm1_0

<number> Level of particulate matter 1.0 measured by the air quality sensor.
unit of measurement: µg/m³

pm2_5

<number> Level of particulate matter 2.5 measured by the air quality sensor.
unit of measurement: µg/m³

pm4_0

<number> Level of particulate matter 4.0 measured by the air quality sensor.
unit of measurement: µg/m³

pm5_0

<number> Level of particulate matter 5.0 measured by the air quality sensor.
unit of measurement: µg/m³

pm10_0

<number> Level of particulate matter 10.0 measured by the air quality sensor.
unit of measurement: µg/m³

pc0_1

<number> Particle count of PM0.1 measured by the air quality sensor.
unit of measurement: #/cm³

pc0_3

<number> Particle count of PM0.3 measured by the air quality sensor.
unit of measurement: #/cm³

pc0_5

<number> Particle count of PM0.5 measured by the air quality sensor.
unit of measurement: #/cm³

pc1_0

<number> Particle count of PM1.0 measured by the air quality sensor.
unit of measurement: #/cm³

pc2_5

<number> Particle count of PM2.5 measured by the air quality sensor.
unit of measurement: #/cm³

pc4_0

<number> Particle count of PM4.0 measured by the air quality sensor.
unit of measurement: #/cm³

pc5_0

<number> Particle count of PM5.0 measured by the air quality sensor.
unit of measurement: #/cm³

pc10_0

<number> Particle count of PM10.0 measured by the air quality sensor.
unit of measurement: #/cm³

particle_size

<number> Particle size
unit of measurement: µg

temp_aq

<number> Temperature value measured by the air quality sensor.
unit of measurement: °C

humidity_aq

<number> Relative humidity value measured by the air quality sensor.
unit of measurement: % RH

pressure_aq

<number> Atmospheric Pressure measured by the air quality sensor.
unit of measurement: hPa

noise_aq

<number> Amount of noise in the environment measured by the air quality sensor.
unit of measurement: dbA

voc_aq

<number> Volatile organic compounds (VOC) index measured by the air quality sensor.
unit of measurement: #

ambient_light

<number> Amount of light in the environment
unit of measurement: lx

no2_gas

<number> Level of nitrogen dioxide measured by the air quality sensor.
unit of measurement: ppm

o3_gas

<number> Level of ozone measured by the air quality sensor.
unit of measurement: ppm

so2_gas

<number> Level of sulfur dioxide measured by the air quality sensor.
unit of measurement: ppm

co_gas

<number> Level of carbon monoxide measured by the air quality sensor.
unit of measurement: ppm

solar_panel_power

<number> 5v out voltage coming from the solar panel.
unit of measurement: mV

wind_speed

<number> Wind speed measured by the wind sensor
unit of measurement: m/s

wind_direction

<number> Wind direction in terms of degree angle.
unit of measurement: deg

temp_external

<number> Temperature value measured by external temperature tag.
unit of measurement: °C

humidity_external

<number> Relative humidity value measured by external humidity tag.
unit of measurement: % RH

co2_gas

<number> Level of carbon dioxide measured by the air quality sensor.
unit of measurement: ppm

nox_aq

<number> NOx index measured by the air quality sensor.

signal_strength

<number> The average value of the received signal strength indication used in the current network bearer.
unit of measurement: dBm

rain_depth

<number> Measurement of the accumulated rainfall in millimeters (mm).
unit of measurement: mm

no_gas

<number> Level of nitric oxide measured by the air quality sensor.
unit of measurement: ppm

h2s_gas

<number> Level of hydrogen sulfide measured by the air quality sensor.
unit of measurement: ppm

x_axis_acceleration_rms

<number> Root mean square (RMS) acceleration measured along the x-axis of the device. The RMS acceleration is a measure of the magnitude of the acceleration vector, averaged over time.
unit of measurement: m/s2

x_axis_peak_component_particle_velocity

<number> Peak velocity of a particle along the x-axis. It represents the highest speed reached by any particle during a particular period.
unit of measurement: mm/s

x_axis_velocity_fft_peak_amplitude_frequency

<number> Frequency at which peak amplitude occurs for velocity along the x-axis. It is determined using Fast Fourier Transform (FFT), a method that converts a signal from its time domain to a frequency domain.
unit of measurement: Hz

x_axis_velocity_fft_peak_amplitude

<number> Peak amplitude of the velocity along the x-axis. Amplitude is the maximum extent of a vibration or oscillation, in this case, the velocity of a particle.
unit of measurement: mm/s

y_axis_acceleration_rms

<number> Root mean square (RMS) acceleration measured along the y-axis of the device. The RMS acceleration is a measure of the magnitude of the acceleration vector, averaged over time.
unit of measurement: m/s2

y_axis_peak_component_particle_velocity

<number> Peak velocity of a particle along the y-axis. It represents the highest speed reached by any particle during a particular period.
unit of measurement: mm/s

y_axis_velocity_fft_peak_amplitude_frequency

<number> Frequency at which peak amplitude occurs for velocity along the y-axis. It is determined using Fast Fourier Transform (FFT), a method that converts a signal from its time domain to a frequency domain.
unit of measurement: Hz

y_axis_velocity_fft_peak_amplitude

<number> Peak amplitude of the velocity along the y-axis. Amplitude is the maximum extent of a vibration or oscillation, in this case, the velocity of a particle.
unit of measurement: mm/s

z_axis_acceleration_rms

<number> Root mean square (RMS) acceleration measured along the z-axis of the device. The RMS acceleration is a measure of the magnitude of the acceleration vector, averaged over time.
unit of measurement: m/s2

z_axis_peak_component_particle_velocity

<number> Peak velocity of a particle along the z-axis. It represents the highest speed reached by any particle during a particular period.
unit of measurement: mm/s

z_axis_velocity_fft_peak_amplitude_frequency

<number> Frequency at which peak amplitude occurs for velocity along the z-axis. It is determined using Fast Fourier Transform (FFT), a method that converts a signal from its time domain to a frequency domain.
unit of measurement: Hz

z_axis_velocity_fft_peak_amplitude

<number> Peak amplitude of the velocity along the z-axis. Amplitude is the maximum extent of a vibration or oscillation, in this case, the velocity of a particle.
unit of measurement: mm/s

peak_particle_velocity

<number> Peak velocity of a particle regardless of the axis. It represents the highest speed reached by any particle during a particular period.
unit of measurement: mm/s

JSON Payload Format:

javascript
{
	"installation_id": <string>,
	"installation_name": <string>,
	"installation_site": <string>,
	"bu_serial": <string>,
	"bu_endpoint": <string>,
	"gps_mode": <number>,
	"polling_interval": <number>,
	"posting_interval": <number>,
	"dataset_id": <number>,
	"timestamp": <number>,
	"battery": <number>,
	"gps_duration_fix": <number>,
	"gps_latitude": <number>,
	"gps_longitude": <number>,
	"gps_speed": <number>,
	"gps_accuracy": <number>,
	"pm0_1": <number>,
	"pm0_3": <number>,
	"pm0_5": <number>,
	"pm1_0": <number>,
	"pm2_5": <number>,
	"pm4_0": <number>,
	"pm5_0": <number>,
	"pm10_0": <number>,
	"pc0_1": <number>,
	"pc0_3": <number>,
	"pc0_5": <number>,
	"pc1_0": <number>,
	"pc2_5": <number>,
	"pc4_0": <number>,
	"pc5_0": <number>,
	"pc10_0": <number>,
	"particle_size": <number>,
	"temp_aq": <number>,
	"humidity_aq": <number>,
	"pressure_aq": <number>,
	"noise_aq": <number>,
	"voc_aq": <number>,
	"ambient_light": <number>,
	"no2_gas": <number>,
	"o3_gas": <number>,
	"so2_gas": <number>,
	"co_gas": <number>,
	"solar_panel_power": <number>,
	"wind_speed": <number>,
	"wind_direction": <number>,
	"temp_external": <number>,
	"humidity_external": <number>,
	"co2": <number>,
	"nox_aq": <number>,
	"signal_strength": <number>,
	"rain_depth": <number>,
	"no_gas": <number>,
	"h2s_gas": <number>,
	"x_axis_acceleration_rms": <number>,
	"x_axis_peak_component_particle_velocity": <number>,
	"x_axis_velocity_fft_peak_amplitude_frequency": <number>,
	"x_axis_velocity_fft_peak_amplitude": <number>,
	"y_axis_acceleration_rms": <number>,
	"y_axis_peak_component_particle_velocity": <number>,
	"y_axis_velocity_fft_peak_amplitude_frequency": <number>,
	"y_axis_velocity_fft_peak_amplitude": <number>,
	"z_axis_acceleration_rms": <number>,
	"z_axis_peak_component_particle_velocity": <number>,
	"z_axis_velocity_fft_peak_amplitude_frequency": <number>,
	"z_axis_velocity_fft_peak_amplitude": <number>,
	"peak_particle_velocity": <number>
}

Prev - Go back to REST API