TALQ 2 Functions

TALQ Consortium

2024-06-27

About TALQ

The TALQ Consortium has developed a global standard protocol to enable Central Management Software to configure, control, command and monitor multiple Outdoor Device Networks from various suppliers through an easy-to-integrate RESTful/JSON protocol. TALQ is open to industry members to join and participate in the evolution of the TALQ Protocol.

TALQ also provides a Partner Program for cities, municipalities, utilities and consultants to contribute to the future of the Smart City. To learn more about us, our members and partners, please visit www.talq-consortium.org

Copyright

This document is published by the TALQ Consortium. All rights are reserved. Reproduction in whole or in part is prohibited without express and prior written permission of the TALQ Consortium. TALQ is a trademark owned by the TALQ Consortium.

About this document

This document details the Functions and Attributes defined by the TALQ Specification Version 2.6.1

For any further explanation of the contents of this document, or in case of any perceived inconsistency or ambiguity of interpretation, please contact the TALQ Consortium:

Disclaimer

The information contained herein is believed to be accurate as of the date of publication, however the copyright holder will not be liable for any damages, including indirect or consequential from use of or reliance on the accuracy of this document.

If you have any questions regarding the content of this document, please contact the TALQ consortium at info@talq-consortium.org.

Terms of use

The document is created and maintained by the TALQ Consortium. Use of this document is governed by the TALQ Consortium Agreement, under which this document has been obtained.

Document History

Document History
Publication date Version Notes
2023-12-14 Draft 1 First draft for release 2.6.0.
New functions: CabinetConfiguration and CabinetMonitor
2024-01-17 Approved Approved release 2.6.0.
2024-06-27 Approved Approved release 2.6.1.

1 References

1.1 Normative References

2 Definitions, Abbreviations and Conventions

2.1 Definitions

2.2 Abbreviations

2.3 Conventions

MUST: This word, or the terms “REQUIRED” or “SHALL”, mean that the definition is an absolute requirement of the specification.

MUST NOT: This phrase, or the phrase “SHALL NOT”, mean that the definition is an absolute prohibition of the specification.

SHOULD: This word, or the adjective “RECOMMENDED”, mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.

SHOULD NOT: This phrase, or the phrase “NOT RECOMMENDED” mean that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.

MAY: This word, or the adjective “OPTIONAL”, mean that an item is truly optional. One vendor may choose to include the item because a particular marketplace requires it or because the vendor feels that it enhances the product while another vendor may omit the same item. An implementation which does not include a particular option MUST be prepared to interoperate with another implementation which does include the option, though perhaps with reduced functionality. In the same vein an implementation which does include a particular option MUST be prepared to interoperate with another implementation which does not include the option (except, of course, for the feature the option provides).

3 TALQ Functions

A TALQ function is composed of configuration attributes, operational attributes, metering attributes and events (the events correspond to status attributes). The configuration, control, command and monitoring of that function can be achieved by sending a RESTful request (GET, PUT, POST, DELETE, PATCH) to manipulate these attributes and events, or by using other more complex TALQ resources (e.g. override, log reports, control programs, etc.).

Functions
Function Description
Basic The Basic function describes the properties related to the physical asset to which the logical device is associated, such as identification (assetId) and location information. There shall be only one instance of the Basic function in a device. This function is mandatory for both Gateway and CMS sides for all physical devices, although the x-talq-profiles definition for Lighting will continue stating that it is optional for Gateway until the release 3.0.0 to keep backwards compatibility. This will be modified at 3.0.0.
Gateway The Gateway function includes the necessary attributes to enable the communication between the CMS and the Gateway according to the TALQ Specification.
Communication The Communication Function contains attributes related to the communication within the ODN, and between ODN devices and Gateways. Although communication within the ODN is outside the scope of the TALQ Smart City Protocol, this Function enables access to a minimum set of configuration and state information of the ODN communication interface in order to facilitate system management from the CMS.
Time The Time function provides information on time reference in the device time zone, and local time. A device shall not have more than one Time function. This function is mandatory for both Gateway and CMS sides, although the x-talq-profiles definition will continue stating that it is optional until the release 3.0.0 to keep backwards compatibility. This will be modified at 3.0.0.
Simple Actuator The Simple Actuator function includes attributes related to generic control and it represents the smallest unit for control purposes. This function allows the new profiles to use actuators without the complexity of calendars
Generic Actuator The Generic Actuator function includes attributes related to generic control and it represents the smallest unit for control purposes.
Lamp Actuator The Lamp Actuator function includes attributes related to lighting control and it represents the smallest unit for control purposes. In practice, however, a Lamp Actuator function can control combinations of several lamps and control gear but all in the same way, as if they are all one individual unit.
Lamp Monitor The Lamp Monitor function enables monitoring of lamp parameters. A Lamp Monitor function should be associated with a specific lamp/control gear combination. Multiple lamp monitor functions may be implemented by a single device.
Electrical Meter The electrical meter function supports electrical metering capabilities including measurements of voltage, current, power, energy, and power factor. This function may be associated with Luminaire Controllers, Cabinet Controllers or electrical meters installed in switch boxes. ODNs may implement both single phase and three phase meters. Typically meters within a control device will be single phase and stand-alone meters. A street side cabinet may have single phase or three phase meters.
Photocell A Photocell function models the capabilities of a photocell that can be used for lighting control. This function shall be supported by the CMS and optionally by the ODNs (Gateway).
Light Sensor A Light Sensor function models the output of light sensor. This function is optional for both CMS and Gateway, but when supported the requirements in this section shall apply.
Binary Sensor A Binary Sensor function can be used to model any sensor that provides a digital, binary output. This function is optional for both CMS and Gateway, but when supported the requirements in this section shall apply.
Generic Sensor A Generic Sensor function can be used to model any sensor that provides an analog or multilevel output. This function is optional for both CMS and Gateway, but when supported the requirements in this section shall apply.
Temperature Sensor The Temperature Sensor function allows a CMS to monitor the temperature in a device and send events in case the value is above/below configurable thresholds.
Humidity Sensor The Humidity Sensor function allows a CMS to monitor the humidity in a device and send events in case the value is above/below configurable thresholds.
Particulate Matter Sensor The Particulate Matter Sensor function allows a CMS to monitor the PM10, PM2.5 and PM1 in a device and send events in case the value is above/below configurable thresholds.
Presence Sensor The Presence Sensor function allows a CMS to detect presence. This function may be used in Parking Place detectors as well as in dynamic outdoor lighting scenario.
Movement Sensor The Movement Sensor function allows a CMS to detect movement. This function may be used in a Waste Container sensor to detect that container gets emptied or is not in the proper position, as well as in asset tracking applications. [DEPRECATED: This function has been deprecated and it will be removed in the next MAJOR release. Please use the new LocationSensorFunction instead]
Location Sensor The Location Sensor Function is used to indicate that an object has changed position attributes configurable by the CMS or based on internal setup of the vendor. For example, a specific location (latitude, longitude) of a device could be defined by the vendor. If the device is equipped with a GPS, it could send a specific event indicating that its position is different to the one defined by the CMS. We might also want to let the configuration to the vendor itself and simply define events notifying the CMS that the default configuration has changed. For example, a garbage bin could have its location defined based on a sensor placed on the floor. If the bin is not above this sensor, the vendor will trigger an event. In this last case, the CMS does not need to configure anything.
Accelerometer The Accelerometer Function is used to indicate that an object has had an impact with another object and to report its acceleration. For example, a light controller placed on a light pole and equipped with an accelerometer can be used to detect an impact (car accident on the light pole).
Orientation The Orientation function is used to indicate that an object has changed orientation based on attributes configurable by the CMS or based on internal setup of the vendor. The target orientation of the object could be configured by the CMS or could be handled by the vendor. In the latter case, the configuration is let to the vendor itself and events are triggered depending on internal configuration.
Battery Level Sensor The Battery Level Sensor function allows to measure the charge of the battery, monitor the battery and send events in case the value is above/below configurable thresholds.
Filling Level Sensor The Filling Level Sensor function allows to measure how full a container is and send events in case the value is above/below configurable thresholds.
Solar Battery Charger A solar battery charger is used to charge a battery with solar energy. Typical use cases are energy demanding off-grid applications like solar lighting, solar vehicle charging (cars and bikes), public transit information, traffic control, public security (CCTV) and many more.
Battery Management System A battery management system is used to monitor the charging and discharging of a battery and protect the battery. Typical use cases are (off-grid) applications like solar lighting, solar vehicle charging (cars and bikes), public transit information, traffic control, public security (CCTV) and many more, where the battery is charged and discharged on a regular basis.
Traffic Counter The Traffic Counter Function is used to provide statistics on the number of vehicles passing on the road. It allows to have the number of pedestrians, bicycles, cars or trucks for a certain period of time that is configurable by the CMS. It also allows to count the number of vehicles using diesel or petrol.
Fluid Level Sensor The Fluid Level Sensor function allows to collect data and events about fluid levels. It could be used to measure fluid levels in channels, lakes, containers, etc.
Waste Container The Waste Container function allows to log when the container is collected and send events in case the date is above a configurable threshold. Additionally it sends events when the contents or container are tampered.
P H Sensor The pH Sensor allows to measure the pH and sends events if the value is above/below the configured thresholds.
Weight Sensor The Weight Sensor allows to measure the weight and sends an event if the value is above/below the thresholds
Gas Sensor The Gas Sensor function allows to measure the gas concentration and sends events if the level is above the configured thresholds.
Segment Monitor The Segment Monitor function enables monitoring of segment parameters. Multiple segment monitor functions may be implemented by a single device.
Noise Monitoring Sensor This sensor function enables monitoring basic noise data.
Atmospheric Sensor This sensor function enables monitoring basic atmospheric data such as barometric pressure, humidity, and temperature. This function complies with WMO standards as reported in the ‘Guide to Instruments and Methods of Observation (WMO-No. 8) / Volume I –Measurement of Meteorological Variables’
Wind Sensor This sensor function enables monitoring wind speed and direction. This function complies with WMO standards as reported in the ‘Guide to Instruments and Methods of Observation (WMO-No. 8) / Volume I –Measurement of Meteorological Variables’
Precipitation Sensor This sensor function enables monitoring precipitation, defined as the liquid or solid products of the condensation of water vapour falling from clouds, in the form of rain, drizzle, snow, snow grains, snow pellets, hail and ice pellets; or falling from clear air in the form of diamond dust. This function complies with WMO standards as reported in the ‘Guide to Instruments and Methods of Observation (WMO-No. 8) / Volume I –Measurement of Meteorological Variables’
Sky Sensor This sensor function enables monitoring of other atmospheric phenomena. This function complies with WMO standards as reported in the ‘Guide to Instruments and Methods of Observation (WMO-No. 8) / Volume I –Measurement of Meteorological Variables’
Gully Sensor The Gully Sensor measures properties associated with street drains or gullies.
Water Flow Sensor The water flow sensor function measures the water flow rate.
Water Quality Sensor The water quality sensor function measures the quality of the water in the drinkable water distribution network, in water tanks or in lakes and rivers.
Text Display Actuator The Text Display Actuator is used to send text to a text-only or text mode graphics display within a PositionedTextState (text, xPos, yPos). Writing a string of text to the text resource causes it to be displayed at the selected X and Y locations on the display. If X or Y are set to a value greater than the size of the display, the position “wraps around” to the modulus of the setting and the display size. Likewise, if the text string overflows the display size, the text “wraps around” and displays on the next line down or, if the last line has been written, wraps around to the top of the display. Brightness and Contrast controls are provided to allow control of various display types including STN and DSTN type LCD character displays. Setting the clearDisplay to true causes the display to be erased.
Parking Sensor The parking sensor provides actual and accumulated occupancy duration as well as forbidden parking detection.
Parking Camera Sensor The Parking Camera Sensor provides information about the parking slots that only computer vision can provide.
Luminaire Asset This entity contains the managed and tracked attributes of a specific Luminaire, excluding the concept of Controller and Driver.
Driver Asset This entity contains the managed and tracked attributes of a specific driver
Controller Asset This entity contains the managed and tracked attributes of a specific controller
Cabinet Configuration The Cabinet Configuration function defines attributes and functionality needed to control light from a street light cabinet regarding the segment monitors
Cabinet Monitor The Cabinet Monitor function defines attributes for monitoring a street light cabinet

3.1 Basic

The Basic function describes the properties related to the physical asset to which the logical device is associated, such as identification (assetId) and location information. There shall be only one instance of the Basic function in a device. This function is mandatory for both Gateway and CMS sides for all physical devices, although the x-talq-profiles definition for Lighting will continue stating that it is optional for Gateway until the release 3.0.0 to keep backwards compatibility. This will be modified at 3.0.0.

See the optionality and profiles information for the Basic function

Basic function’s attributes
ID Type Scope Unit Description
displayName AttributeString configuration None Display name of the asset.
assetId AttributeString configuration None Customer identifier of the asset. If multiple devices have the same assetId it means they belong to the same asset.
serial AttributeString configuration None Serial number of the device.
hwType AttributeString configuration None Hardware type of the device.
hwVersion AttributeString configuration None Hardware revision of the device.
swType AttributeString configuration None Software type of device. This attribute may be useful if the same hardware supports multiple firmware versions with different functions.
swVersion AttributeString configuration None Software version installed on the device.
installationDate AttributeDateTime configuration None The installation date of Physical Device.
location AttributeLocation configuration None Latitude, Longitude and Altitude. [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new LocationSensorFunction.location instead]
deviceReset AttributeBoolean event None The physical device containing the logical device was reset.
softwareUpdating AttributeBoolean event None Indicates software updating is in progress.
hardwareUpdating AttributeBoolean event None Indicates that hardware associated with this logical device has been updated. [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new hardwareUpdated instead]
hardwareUpdated AttributeBoolean event None Indicates that hardware associated with this logical device has been updated.
batteryMode AttributeBoolean event None Device operating in battery mode.
installationMode AttributeBoolean event None Device is being installed.
maintenanceMode AttributeBoolean event None Device is undergoing maintenance, where maintenance may include hardware or software related maintenance actions.
cabinetDoorOpen AttributeBoolean event None Cabinet door is open. [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new SegmentMonitor.cabinetDoorOpen instead]
batteryShutdown AttributeBoolean event None Indicates the device has shut down due to battery discharge.
locationUpdated AttributeBoolean event None Indicates the location of a device has changed, but detecting the change is outside the scope of the TALQ Specification.[DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new LocationSensorFunction.locationChanged instead]
timeZone AttributeString configuration None Time zone of the device. Time zone may be expressed in two formats. where is a time zone as defined in the zone.tab of the IANA timezone database [IANA]; and stdoffset[dst[offset][,start[/time],en d[/time]]] as defined by the Open Group for posix systems [POSIX]. [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new TimeFunction.timeZone instead]
ntpServers AttributeStringArray configuration None List of NTP servers to use for time synchronization (Hostname or IP address). [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new TimeFunction.ntpServers instead]
ntpSynchPeriod AttributeInteger configuration Hours Number of hours between two time synchronization updates. [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new TimeFunction.ntpSynchPeriod instead]
currentTime AttributeDateTime measurement None Current time of the device defined as local time with time zone designator. [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new TimeFunction.currentTime instead]
commandConfirmation AttributeBoolean configuration None Allows the CMS to reboot, factory reset or configuration reset of the device. Before rebooting or resetting the device this attribute has to be true. Default value = false
reboot AttributeBoolean operational None Reboot the device. This operational attribute requires the commandConfirmation attribute value to be set to true.
factoryReset AttributeBoolean operational None Reset the device to factory settings. This operational attribute requires the commandConfirmation attribute value to be set to true.
configurationReset AttributeBoolean operational None Reset the device configuration settings. This operational attribute requires the commandConfirmation attribute value to be set to true.
operatingHours AttributeInteger measurement Hours Number of operating hours of the device.

3.2 Gateway

The Gateway function includes the necessary attributes to enable the communication between the CMS and the Gateway according to the TALQ Specification.

See the optionality and profiles information for the Gateway function

Gateway function’s attributes
ID Type Scope Unit Description
cmsUri AttributeUri configuration None Base URI for TALQ communication that allows the Gateway to access the CMS. Must be an absolute URI. Other URI’s for accessing CMS can be relative to this base.
cmsAddress AttributeString configuration None A Universally Unique IDentifiers (UUID) which uniquelly identifies the CMS. Any REST request sent by the CMS must include a REST parameter named ‘clientAddress’ set with this ‘cmsAddress’ value. The method through which the CMS determines its own TALQ address is not in the scope of TALQ.
gatewayUri AttributeUri configuration None Base URI for TALQ communication that allows the CMS to access the Gateway. Must be an absolute URI. Other URI’s for accessing Gateway can be relative to this base.
gatewayAddress AttributeString configuration None A Universally Unique IDentifiers (UUID) which uniquelly identifies the Gateway. Any REST request sent by the Gateway must include a REST parameter named ‘clientAddress’ set with this ‘gatewayAddress’ value. The Gateway address shall be created and assigned by the CMS as the first step of the bootstrap process (refer to section 5.1 of TALQ Specification for more details of the bootstrap process).
retryPeriod AttributeFloat configuration Seconds Time duration before the Gateway retransmits a message for which expected response has not been received. [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new GatewayFunction.gatewayRetryPeriod instead]
gatewayRetryPeriod AttributeFloat configuration Seconds Time duration before the Gateway retransmits a message for which the expected response has not been received. This attribute can be used by the CMS to avoid requests overload. Although this attribute will be mandatory for Gateway in future MAJOR versions, to keep backward compatibility it is considered optional for the existing profiles.
cmsRetryPeriod AttributeFloat configuration Seconds Time duration before the CMS retransmits a message for which the expected response has not been received. This attribute can be used by the Gateway to avoid requests overload. Although this attribute will be mandatory for CMS in future MAJOR versions, to keep backward compatibility it is considered optional for the existing profiles.
gatewayNumberOfRetries AttributeInteger configuration None Maximum number of retries for a failed request sent by the Gateway for which expected response has not been received. Default value shall be 3. This attribute can be used by the CMS to avoid requests overload. Although this attribute will be mandatory for Gateway in future MAJOR versions, to keep backward compatibility it is considered optional for the existing profiles
cmsNumberOfRetries AttributeInteger configuration None Maximum number of retries for a failed request sent by the CMS for which expected response has not been received. Default value shall be 3. This attribute can be used by the Gateway to avoid requests overload. Although this attribute will be mandatory for CMS in future MAJOR versions, to keep backward compatibility it is considered optional for the existing profiles
crlUrn AttributeUri configuration None URI where the Gateway can obtain the Certification Revocation List (CRL).
vendor AttributeString configuration None Vendor identification.
pkgUrl AttributeUri configuration None URL pointing at location packages can be downloaded. This is used in the data package service.
currentReleaseId AttributeString measurement None Release ID of currently deployed release. This is used in the data package service.
newCmsAttached AttributeBoolean event None This attribute is updated if, prior to the current bootstrap, one or more other CMS were already attached. Support for more than one CMS is optional.

3.3 Communication

The Communication Function contains attributes related to the communication within the ODN, and between ODN devices and Gateways. Although communication within the ODN is outside the scope of the TALQ Smart City Protocol, this Function enables access to a minimum set of configuration and state information of the ODN communication interface in order to facilitate system management from the CMS.

See the optionality and profiles information for the Communication function

Communication function’s attributes
ID Type Scope Unit Description
communicationType AttributeString configuration None Type of communication technology implemented by the ODN (e.g. power line, wireless).
logicalAddress AttributeString configuration None Logical address for communication within the ODN scope (IP address, Short Address, …).
altLogicalAddress AttributeString configuration None Additional logical address used for communication within the ODN, for instance, group communication address (not a TALQ group address).
physicalAddress AttributeString configuration None Physical address of the device. For example, IEEE MAC address. This attribute can be used to map between logical and physical devices. The format is specific to the ODN implementation.
parentAddress AttributeString configuration None TALQ Address of the parent device, e.g. gateway. It shall point to a specific communication function.
timeToLive AttributeInteger configuration None Number of times a packet can be forwarded within the ODN.
repeatingEnabled AttributeBoolean configuration None Describes whether repeating functionality is enabled at the device.
transmitPower AttributeFloat configuration dBm Transmit power used by the device within the ODN. (dBm)
numberOfHops AttributeInteger measurement None Number of hops between the gateway and the ODN device represented by the device including this function.
communicationQuality AttributeFloat measurement Percent Indicator of the quality of the communication with the device. 100% means good quality.
communicationFailure AttributeBoolean event None This attribute is updated by the ODN when the communication function is not operating as expected.
applicationType AttributeString configuration None Application Type of the communication function depending on the use case. E.g.: ‘PL Communication Monitor’

3.4 Time

The Time function provides information on time reference in the device time zone, and local time. A device shall not have more than one Time function. This function is mandatory for both Gateway and CMS sides, although the x-talq-profiles definition will continue stating that it is optional until the release 3.0.0 to keep backwards compatibility. This will be modified at 3.0.0.

See the optionality and profiles information for the Time function

Time function’s attributes
ID Type Scope Unit Description
timeZone AttributeString configuration None Time zone of the device. Time zone may be expressed in two formats. where is a time zone as defined in the zone.tab of the IANA timezone database [IANA]; and stdoffset[dst[offset][,start[/time],en d[/time]]] as defined by the Open Group for posix systems [POSIX].
ntpServers AttributeStringArray configuration None List of NTP servers to use for time synchronization (Hostname or IP address).
ntpSynchPeriod AttributeInteger configuration Hours Number of hours between two time synchronization updates.
currentTime AttributeDateTime measurement None Current time of the device defined as local time with time zone designator.
lastTimeSync AttributeDateTime measurement None Last time at which a successful time synchronization occurred.
lastSyncError AttributeBoolean event None Set to True in case the latest time synchronization operation failed. Set to False in case the last operation succeeded.

3.5 Simple Actuator

The Simple Actuator function includes attributes related to generic control and it represents the smallest unit for control purposes. This function allows the new profiles to use actuators without the complexity of calendars

See the optionality and profiles information for the Simple Actuator function

Simple Actuator function’s attributes
ID Type Scope Unit Description
defaultState AttributeState configuration None Sets the default state output for the simple actuator. This shall be applicable if the actuator is not under an override control (OverrideCommand).
actualState AttributeState measurement None This attribute should reflect the physical state of the source as much as possible. It may be calculated or measured, depending on the specific ODN implementation, which is outside the scope of this specification.
targetCommand AttributeCommand operational None Latest command for the simple actuator.
feedbackCommand AttributeCommand measurement None This attribute reflects the command currently controlling the actuator. The actualState might be different due to propagation time, or due to internal ODN specific mechanisms to handle the priority of the requests or response time.
stateChange AttributeBoolean event None This attribute reflects that the state has changed
targetCommandChange AttributeBoolean event None This attribute reflects that the targetCommand has changed.
applicationType AttributeString configuration None Application Type of the simple actuator depending on the use case. E.g.: ‘Water valve’

3.6 Generic Actuator

The Generic Actuator function includes attributes related to generic control and it represents the smallest unit for control purposes.

See the optionality and profiles information for the Generic Actuator function

Generic Actuator function’s attributes
ID Type Scope Unit Description
defaultState AttributeState configuration None Sets the default state output for the generic actuator. This shall be applicable if the actuator is not under any scheduled (calendarID) or override control (OverrideCommand).
actualState AttributeState measurement None This attribute should reflect the physical state of the source as much as possible. It may be calculated or measured, depending on the specific ODN implementation, which is outside the scope of this specification.
targetCommand AttributeCommand operational None Latest command for the generic actuator.
feedbackCommand AttributeCommand measurement None This attribute reflects the command in effect and it might deviate from the actualState due to propagation time, due to scheduler specific or due to internal ODN specific mechanisms to handle the priority of the requests or response time.
stateChange AttributeBoolean event None This attribute reflects that the state has changed
calendarID AttributeString operational None TALQ Address of the calendar controlling this generic actuator. If this attribute is empty, the behavior shall be determined by the ODN. If the attribute is invalid, the ODN shall trigger a generic invalid address event and the behavior shall be determined by the ODN.
invalidCalendar AttributeBoolean event None This attribute reflects that a calendar has been allocated and can not be implemented it.
invalidProgram AttributeBoolean event None This attribute reflects that a control program has been allocated and can not be implemented it
programChange AttributeBoolean event None This attribute reflects that the control program applicable to the actuator has changed.
calendarChange AttributeBoolean event None This attribute reflects that the calendar applicable to the actuator has changed.
targetCommandChange AttributeBoolean event None This attribute reflects that the targetCommand has changed.
applicationType AttributeString configuration None Application Type of the generic actuator depending on the use case. E.g.: ‘Water valve’

3.7 Lamp Actuator

The Lamp Actuator function includes attributes related to lighting control and it represents the smallest unit for control purposes. In practice, however, a Lamp Actuator function can control combinations of several lamps and control gear but all in the same way, as if they are all one individual unit.

See the optionality and profiles information for the Lamp Actuator function

Lamp Actuator function’s attributes
ID Type Scope Unit Description
lampTypeId AttributeString configuration None TALQ Address of an existing lampType.
outputPort AttributeString configuration None Identifier of the output port that is controlled by the lamp actuator.
standbyMode AttributeBinary configuration None Defines the behavior of the lamp actuator when output level is set to zero. If OFF, light output level is zero with no power to the lamp control gear. If ON, light output level is zero but power is delivered to the lamp control gear (standby mode).
cloEnabled AttributeBoolean configuration None Determines whether a Constant Light Output (CLO) correction factor is used. CLO is used to compensate for lumen output degradation over the life time of the lamp. If CLO is enabled, lamps are dimmed part of the lampType.
defaultLightState AttributeLevelState configuration Percent Sets the default light output for the lamp actuator. This shall be applicable if the actuator is not under any scheduled (calendarID) or override control (OverrideCommand). This attribute shall be set to 100% as default value.
targetLightCommand AttributeCommand operational None Latest command for the lamp actuator.
feedbackLightCommand AttributeCommand measurement None This attribute reflects the command in effect and it might deviate from the actualLightState due to propagation time, due to scheduler specific or due to internal ODN specific mechanisms to handle the priority of the requests or response time.
actualLightState AttributeLevelState measurement Percent This attribute should reflect the physical state of the light source as much as possible, including factors such as CLO. It may be calculated or measured, depending on the specific ODN implementation, which is outside the scope of this specification.
maintenanceFactorEnabled AttributeBoolean configuration None Indicates whether maintenance compensation is enabled. A maintenance factor can be added in addition to the CLO correction factor to account effects of maintenance (e.g. cleaning) of the luminaire on the lumen output.
maintenancePeriod AttributeInteger configuration Hours Period (Hours) after which maintenance factor is 100%. The assumption is that the maintenance correction factor vs. time curve is linear.
maintenanceFactor AttributePercent configuration Percent Initial correction factor applied when the luminaire is cleaned.
lastMaintenanceDate AttributeDateTime operational None Date when the luminaire was last cleaned (used to reset the maintenance factor).
calendarID AttributeString operational None TALQ Address of the calendar controlling this lamp actuator. If this attribute is empty, the behavior shall be determined by the ODN. If the attribute is invalid, the ODN shall trigger a generic invalid address event and the behavior shall be determined by the ODN.
invalidCalendar AttributeBoolean event None The lamp actuator function has been allocated a calendar that it cannot implement.
invalidProgram AttributeBoolean event None The lamp actuator function has been allocated a control program that it cannot implement.
lightStateChange AttributeBoolean event None Light state has changed.
targetLightCommandChange AttributeBoolean event None The targetLightCommand operational attribute has changed.
programChange AttributeBoolean event None The control program applicable to the lamp actuator has changed (these are the points at which the calendar changes the program).
calendarChange AttributeBoolean event None The calendar applicable to the lamp actuator has changed.
invalidLampType AttributeBoolean event None Indicates that the lamp type referred cannot be applied.
applicationType AttributeString configuration None Application Type of the lamp actuator depending on the use case. E.g.: ‘Lamp actuator; Cabinet actuator’

3.8 Lamp Monitor

The Lamp Monitor function enables monitoring of lamp parameters. A Lamp Monitor function should be associated with a specific lamp/control gear combination. Multiple lamp monitor functions may be implemented by a single device.

See the optionality and profiles information for the Lamp Monitor function

Lamp Monitor function’s attributes
ID Type Scope Unit Description
supplyType AttributeSupplyType configuration None Supply type of the lamp. Accepted values are: AC, DC.
lampTypeId AttributeString configuration None TALQ Address of an existing lamp type. If not set to a valid value, this shall be the lamp type used in the lamp actuator. If this attribute is not supported in the implementation, the lamp monitor shall use the lamp type specified in the corresponding lamp actuator.
monitoringReference AttributeString configuration None Name of the entity (or physical device) being monitored by this function.
actuatorReference AttributeString configuration None Function ID of the actuator, located in the same device, whose effect is being monitored by this function. e.g.: fLampActuatorId_1 or fGenericActuatorId_2
numberOfLamps AttributeInteger configuration None Number of lamps being monitored by the lamp monitor function.
switchOnCounter AttributeInteger measurement None Cumulative number of ON/OFF cycles since installation of the lamp. The wrap around value is 2e32 – 1.
operatingHours AttributeFloat measurement Hours Number of hours the lamp is on. This is the value used in CLO and may be set by the CMS.
temperature AttributeFloat measurement DegreesCelcius Temperature of the device implementing this function. [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new TemperatureSensorFunction.temperature instead]
supplyVoltage AttributeFloat measurement Volts RMS supply volts when supplyType is AC, supply voltage (V) when supplyType is DC.
supplyCurrent AttributeFloat measurement Amperes RMS supply current (A) when supplyType is AC, supply current (A) when supplyType is DC.
activePower AttributeFloat measurement Watts Active power. (W)
reactivePower AttributeFloat measurement VoltAmpereReactive Reactive power.
apparentPower AttributeFloat measurement VoltAmperes Apparent Power.
powerFactor AttributeFloat measurement None Active power/Apparent power. The power factor can get values in the range from 0 to 1.
powerFactorSense AttributeFactorSense measurement None Phase sense of power factor.
activeEnergy AttributeFloat measurement KiloWattHours Cumulative active energy (since installation or counter reset).
supplyLossCount AttributeInteger measurement None Incrementing count of supply losses. The wrap around value is 2e32 – 1.
lampPowerTooHigh AttributeBoolean event None Lamp power is greater than expected lamp power + lampPowerTolerance.
lampPowerTooLow AttributeBoolean event None Lamp power is smaller than expected lamp power - lampPowerTolerance.
lampVoltageTooHigh AttributeBoolean event None Level of lamp voltage (not supply voltage) is greater than highLampVoltageThreshold.
lampVoltageTooLow AttributeBoolean event None Level of lamp voltage (not supply voltage) is smaller than lowLampVoltageThreshold.
lampFailure AttributeBoolean event None The lamp is not operating as it is supposed to (e.g. the lamp is broken). This event shall be used to detect a situation where the lamp (or LED module(s)) should be lit, but produce no light. This could be detected by the current flowing or power consumed.
dimmingFailure AttributeBoolean event None The lamp is not dimming as it is supposed to (e.g. the driver is not connected properly). This event shall be used to detect a situation where the lamp (or LED module(s)) is lighting at a dimming level which is different from the expected dimming level, taking into account the programmed (or manual) level as well any correction (e.g. virtual power, constant light output).
currentTooHigh AttributeBoolean event None Supply current is above the highCurrentThreshold defined in the lamp type.
currentTooLow AttributeBoolean event None Supply current is below the lowCurrentThreshold defined in the lamp type.
powerFactorTooLow AttributeBoolean event None The power factor is below powerFactorThreshold.
highTemperature AttributeBoolean event None Indicates temperature is above the high threshold. [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new TemperatureSensorFunction.temperatureTooHigh instead]
relayFailure AttributeBoolean event None Set in case of internal relay is failing (e.g. it may be stuck in either on or off position). Typically if contactor error isused as well.
absolutLampPowerTooHigh AttributeBoolean event None Indicates the power is above the lampPowerHighThreshold in the lamp type. [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new absoluteLampPowerTooHigh instead]
absolutLampPowerTooLow AttributeBoolean event None Indicates the power is below the lampPowerLowThreshold in the lamp type. [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new absoluteLampPowerTooLow instead]
absoluteLampPowerTooHigh AttributeBoolean event None Indicates the power is above the lampPowerHighThreshold in the lamp type.
absoluteLampPowerTooLow AttributeBoolean event None Indicates the power is below the lampPowerLowThreshold in the lamp type.
controlGearCommFailure AttributeBoolean event None Indicates failure of the control gear.
cyclingFailure AttributeBoolean event None Indicates the lamp is constantly switching ON and OFF in an unexpected manner. This event shall be used to indicate a lamp which cycles while it should be on. The actual detection algorithm is outside the scope of this specification.
supplyLoss AttributeBoolean event None Indicates loss of supply (power)
contactorError AttributeBoolean event None Indicate error in contactor. For instance, if a contactor (relay) is used, the contactor may be stuck in either of the positions (on or off).
lampUnexpectedOn AttributeBoolean event None Indicates lamp is unexpectedly on.
leakageDetected AttributeBoolean event None Indicates that an earth leakage fault has been detected.
invalidLampType AttributeBoolean event None Indicates that the lamp type referred cannot be applied.
supplyVoltageTooHigh AttributeBoolean event None Level of supply voltage is above the highLampVoltageThreshold.
supplyVoltageTooLow AttributeBoolean event None Level of supply voltage is below the lowSupplyVoltageThreshold.
highSupplyVoltageThreshold AttributeFloat configuration Volts Supply voltage above which the supplyVoltageTooHigh event is triggered. (V)
lowSupplyVoltageThreshold AttributeFloat configuration Volts Supply voltage below which the supplyVoltageTooLow event is triggered. (V)
applicationType AttributeString configuration None Application Type of the lamp monitor depending on the use case. E.g.: ‘LED Monitor’

3.9 Electrical Meter

The electrical meter function supports electrical metering capabilities including measurements of voltage, current, power, energy, and power factor. This function may be associated with Luminaire Controllers, Cabinet Controllers or electrical meters installed in switch boxes. ODNs may implement both single phase and three phase meters. Typically meters within a control device will be single phase and stand-alone meters. A street side cabinet may have single phase or three phase meters.

See the optionality and profiles information for the Electrical Meter function

Electrical Meter function’s attributes
ID Type Scope Unit Description
totalPowerHighThreshold AttributeFloat configuration KiloWatt Power above which the totalPowerTooHigh event is triggered.
totalPowerLowThreshold AttributeFloat configuration KiloWatt Power below which the totalPowerTooLow event is triggered.
powerfactorThreshold AttributeFloat configuration None Power factor below which the powerfactorTooLow event is triggered.
phase1PowerfactorLowThreshold AttributeFloat configuration None Phase 1 power factor below which the phase1PowerfactorTooLow event is triggered.
phase2PowerfactorLowThreshold AttributeFloat configuration None Phase 2 power factor below which the phase2PowerfactorTooLow event is triggered.
phase3PowerfactorLowThreshold AttributeFloat configuration None Phase 3 power factor below which the phase3PowerfactorTooLow event is triggered.
supplyVoltageHighThreshold AttributeFloat configuration Volts Supply voltage above which the supplyVoltageTooHigh event is triggered. (V)
supplyVoltageLowThreshold AttributeFloat configuration Volts Supply voltage below which the supplyVoltageTooLow event is triggered. (V)
phase1VoltageHighThreshold AttributeFloat configuration Volts RMS voltage above which the phase1VoltageTooHigh event is triggered.
phase1VoltageLowThreshold AttributeFloat configuration Volts RMS voltage below which the phase1VoltageTooLow event is triggered.
phase2VoltageHighThreshold AttributeFloat configuration Volts RMS voltage above which the phase2VoltageTooHigh event is triggered.
phase2VoltageLowThreshold AttributeFloat configuration Volts RMS voltage below which the phase2VoltageTooLow event is triggered.
phase3VoltageHighThreshold AttributeFloat configuration Volts RMS voltage above which the phase3VoltageTooHigh event is triggered.
phase3VoltageLowThreshold AttributeFloat configuration Volts RMS voltage below which the phase3VoltageTooLow event is triggered.
totalCurrentHighThreshold AttributeFloat configuration Amperes RMS current above which the currentTooHigh event is triggered.
totalCurrentLowThreshold AttributeFloat configuration Amperes RMS current below which the currentTooLow event is triggered.
neutralCurrentHighThreshold AttributeFloat configuration Amperes RMS current above which the neutralCurrentTooHigh event is triggered.
phase1CurrentHighThreshold AttributeFloat configuration Amperes RMS current above which the phase1CurrentTooHigh event is triggered.
phase1CurrentLowThreshold AttributeFloat configuration Amperes RMS current below which the phase1CurrentTooLow event is triggered.
phase2CurrentHighThreshold AttributeFloat configuration Amperes RMS current above which the phase2CurrentTooHigh event is triggered.
phase2CurrentLowThreshold AttributeFloat configuration Amperes RMS current below which the phase2CurrentTooLow event is triggered.
phase3CurrentHighThreshold AttributeFloat configuration Amperes RMS current above which the phase3CurrentTooHigh event is triggered.
phase3CurrentLowThreshold AttributeFloat configuration Amperes RMS current below which the phase3CurrentTooLow event is triggered.
phase1ActivePowerHighThreshold AttributeFloat configuration Watts Power above which the phase1ActivePowerTooHigh event is triggered.
phase1ActivePowerLowThreshold AttributeFloat configuration Watts Power below which the phase1ActivePowerTooLow event is triggered.
phase2ActivePowerHighThreshold AttributeFloat configuration Watts Power above which the phase2ActivePowerTooHigh event is triggered.
phase2ActivePowerLowThreshold AttributeFloat configuration Watts Power below which the phase2ActivePowerTooLow event is triggered.
phase3ActivePowerHighThreshold AttributeFloat configuration Watts Power above which the phase3ActivePowerTooHigh event is triggered.
phase3ActivePowerLowThreshold AttributeFloat configuration Watts Power below which the phase3ActivePowerTooLow event is triggered.
totalPower AttributeFloat measurement KiloWatt Sum of the active power consumed on phase 1, 2 and 3, or just the power for a single phase meter.
totalVA AttributeFloat measurement KiloVoltAmpere Sum of the apparent power consumed on phase 1, 2 and 3, or just the apparent power for a single phase meter.
totalVAR AttributeFloat measurement KiloVoltAmpereReactive Sum of the reactive power consumed on phase 1, 2 and 3, or just the reactive power for a single phase meter.
maxDemandPower AttributeFloat measurement KiloWatt Maximum peak power consumption.
totalActiveEnergy AttributeFloat measurement KiloWattHours Total cumulative kWh measured by the meter since installation date (or counter reset).
totalReactiveEnergy AttributeFloat measurement KiloVoltAmpereReactiveHours Total cumulative kVArh measured by the meter since installation date (or counter reset).
totalApparentEnergy AttributeFloat measurement KiloVoltAmpereHours Total cumulative kVAh measured by the meter since installation date (or counter reset).
frequency AttributeFloat measurement Hertz Frequency on the line.
totalPowerFactor AttributeFloat measurement None Total active power divided by total apparent power.
totalPowerFactorSense AttributeFactorSense measurement None Sense of power factor (lead or lag).
phase1PowerFactor AttributeFloat measurement None Power factor on phase 1.
phase1PowerFactorSense AttributeFactorSense measurement None Sense of power factor (lead or lag).
phase2PowerFactor AttributeFloat measurement None Power factor on phase 2.
phase2PowerFactorSense AttributeFactorSense measurement None Sense of power factor (lead or lag).
phase3PowerFactor AttributeFloat measurement None Power factor on phase 3.
phase3PowerFactorSense AttributeFactorSense measurement None Sense of power factor (lead or lag).
supplyVoltage AttributeFloat measurement Volts Average between Phase1 RMS Voltage, Phase2 RMS Voltage and Phase3 RMS Voltage, or in the case of a single phase meter just the RMS supply voltage.
phase1Voltage AttributeFloat measurement Volts RMS Voltage between phase 1 and neutral.
phase2Voltage AttributeFloat measurement Volts RMS Voltage between phase 2 and neutral.
phase3Voltage AttributeFloat measurement Volts RMS Voltage between phase 3 and neutral.
voltagePhase1Phase2 AttributeFloat measurement Volts RMS Voltage between phase 1 and phase 2.
voltagePhase2Phase3 AttributeFloat measurement Volts RMS Voltage between phase 2 and phase 3.
voltagePhase3Phase1 AttributeFloat measurement Volts RMS Voltage between phase 3 and phase 1.
totalCurrent AttributeFloat measurement Amperes Sum of the RMS currents on phase 1, 2 and 3.
averageCurrent AttributeFloat measurement Amperes Average RMS current on phase 1, 2 and 3.
neutralCurrent AttributeFloat measurement Amperes RMS current on neutral.
phase1Current AttributeFloat measurement Amperes RMS current on phase 1.
phase2Current AttributeFloat measurement Amperes RMS current on phase 2.
phase3Current AttributeFloat measurement Amperes RMS current on phase 3.
phase1ActivePower AttributeFloat measurement KiloWatt Active Power on phase 1.
phase2ActivePower AttributeFloat measurement KiloWatt Active Power on phase 2.
phase3ActivePower AttributeFloat measurement KiloWatt Active Power on phase 3.
phase1ApparentPower AttributeFloat measurement KiloVoltAmpere Apparent Power on phase 1.
phase2ApparentPower AttributeFloat measurement KiloVoltAmpere Apparent Power on phase 2.
phase3ApparentPower AttributeFloat measurement KiloVoltAmpere Apparent Power on phase 3.
phase1ReactivePower AttributeFloat measurement KiloVoltAmpereReactive Reactive Power on phase 1.
phase2ReactivePower AttributeFloat measurement KiloVoltAmpereReactive Reactive Power on phase 2.
phase3ReactivePower AttributeFloat measurement KiloVoltAmpereReactive Reactive Power on phase 3.
phase1ActiveEnergy AttributeFloat measurement KiloWattHours Cumulative active energy on phase 1.
phase2ActiveEnergy AttributeFloat measurement KiloWattHours Cumulative active energy on phase 2.
phase3ActiveEnergy AttributeFloat measurement KiloWattHours Cumulative active energy on phase 3.
worstCurrentTHD AttributeFloat measurement Percent Worst value for Total Harmonic Distortion on current (all 3 phases).
phase1CurrentTHD AttributeFloat measurement Percent Total Harmonic Distortion on current for phase 1.
phase2CurrentTHD AttributeFloat measurement Percent Total Harmonic Distortion on current for phase 2.
phase3CurrentTHD AttributeFloat measurement Percent Total Harmonic Distortion on current for phase 3.
worstVoltageTHD AttributeFloat measurement Percent Worst Total Harmonic Distortion on voltage (all 3 phases).
averageVoltageTHD AttributeFloat measurement Percent Average value of Total Harmonic Distortion on voltage.
phase1VoltageTHD AttributeFloat measurement Percent Total Harmonic Distortion on voltage for phase 1.
phase2VoltageTHD AttributeFloat measurement Percent Total Harmonic Distortion on voltage for phase 2.
phase3VoltageTHD AttributeFloat measurement Percent Total Harmonic Distortion on voltage for phase 3.
phase1_2VoltageTHD AttributeFloat measurement Percent Total Harmonic Distortion on voltage between phase 1 and phase 2.
phase2_3VoltageTHD AttributeFloat measurement Percent Total Harmonic Distortion on voltage between phase 2 and phase 3.
phase3_1VoltageTHD AttributeFloat measurement Percent Total Harmonic Distortion on voltage between phase 3 and phase 1.
supplyLossCount AttributeInteger measurement None Incrementing count of supply losses. In the case of 3 phases the count of losses on all three phases together. The wrap around value is 2e32 – 1.
phase1SupplyLossCount AttributeInteger measurement None Incrementing count of supply losses on Phase 1. The wrap around value is 2e32 – 1.
phase2SupplyLossCount AttributeInteger measurement None Incrementing count of supply losses on Phase 2. The wrap around value is 2e32 – 1.
phase3SupplyLossCount AttributeInteger measurement None Incrementing count of supply losses on Phase 3. The wrap around value is 2e32 – 1.
totalPowerTooHigh AttributeBoolean event None Indicates total power is above the totalPowerHighThreshold.
totalPowerTooLow AttributeBoolean event None Indicates total power is below the totalPowerLowThreshold.
powerfactorTooLow AttributeBoolean event None Indicates the power factor is below the powerfactorThreshold.
phase1PowerfactorTooLow AttributeBoolean event None Indicates the phase 1 power factor is below the phase1PowerfactorLowThreshold.
phase2PowerfactorTooLow AttributeBoolean event None Indicates the phase 2 power factor is below the phase1PowerfactorLowThreshold.
phase3PowerfactorTooLow AttributeBoolean event None Indicates the phase 3 power factor is below the phase1PowerfactorLowThreshold.
supplyVoltageTooHigh AttributeBoolean event None Indicates supply voltage is above the supplyVoltageHighThreshold.
supplyVoltageTooLow AttributeBoolean event None Indicates supply voltage is below the supplyVoltageLowThreshold.
phase1VoltageTooHigh AttributeBoolean event None Indicates phase 1 supply voltage is above the phase1VoltageHighThreshold.
phase1VoltageTooLow AttributeBoolean event None Indicates phase 1 supply voltage is below the phase1VoltageLowThreshold.
phase2VoltageTooHigh AttributeBoolean event None Indicates phase 2 supply voltage is above the phase2VoltageHighThreshold.
phase2VoltageTooLow AttributeBoolean event None Indicates phase 2 supply voltage is below the phase2VoltageLowThreshold.
phase3VoltageTooHigh AttributeBoolean event None Indicates phase 3 supply voltage is above the phase3VoltageHighThreshold.
phase3VoltageTooLow AttributeBoolean event None Indicates phase 3 supply voltage is below the phase3VoltageLowThreshold.
totalCurrentTooHigh AttributeBoolean event None Indicates the current is above the totalCurrentHighThreshold.
totalCurrentTooLow AttributeBoolean event None Indicates the current is below the totalCurrentLowThreshold.
neutralCurrentTooHigh AttributeBoolean event None Indicates the neutral current is above the neutralCurrentHighThreshold.
phase1CurrentTooHigh AttributeBoolean event None Indicates the phase 1 current is above the phase1CurrentHighThreshold.
phase1CurrentTooLow AttributeBoolean event None Indicates the phase 1 current is below the phase1CurrentLowThreshold.
phase2CurrentTooHigh AttributeBoolean event None Indicates the phase 2 current is above the phase2CurrentHighThreshold.
phase2CurrentTooLow AttributeBoolean event None Indicates the phase 2 current is below the phase2CurrentLowThreshold.
phase3CurrentTooHigh AttributeBoolean event None Indicates the phase 3 current is above the phase3CurrentHighThreshold.
phase3CurrentTooLow AttributeBoolean event None Indicates the phase 3 current is below the phase3CurrentLowThreshold.
phase1ActivePowerTooHigh AttributeBoolean event None Indicates the phase 1 active power is above the phase1ActivePowerHighThreshold.
phase1ActivePowerTooLow AttributeBoolean event None Indicates the phase 1 active power is below the phase1ActivePowerLowThreshold.
phase2ActivePowerTooHigh AttributeBoolean event None Indicates the phase 2 active power is above the phase2ActivePowerHighThreshold.
phase2ActivePowerTooLow AttributeBoolean event None Indicates the phase 2 active power is below the phase2ActivePowerLowThreshold.
phase3ActivePowerTooHigh AttributeBoolean event None Indicates the phase 3 active power is above the phase3ActivePowerHighThreshold.
phase3ActivePowerTooLow AttributeBoolean event None Indicates the phase 3 active power is below the phase3ActivePowerLowThreshold.
applicationType AttributeString configuration None Application Type of the electrical meter depending on the use case. E.g.: ‘Lamp Electrical Meter; Segment Electrical Meter’
actuatorReference AttributeString configuration None Function ID of the actuator, located in the same device, whose effect is being monitored by this function. e.g.: fLampActuatorId_1 or fGenericActuatorId_2
supplyLoss AttributeBoolean event None Indicates loss of supply (power)

3.10 Photocell

A Photocell function models the capabilities of a photocell that can be used for lighting control. This function shall be supported by the CMS and optionally by the ODNs (Gateway).

See the optionality and profiles information for the Photocell function

Photocell function’s attributes
ID Type Scope Unit Description
onLevel AttributeFloat configuration Illuminance Illuminance level at which the photocell switches to on state.
offLevel AttributeFloat configuration Illuminance Illuminance level at which the photocell switches to off state.
photocellOutput AttributeBinary measurement None Output state of the photocell. Possible values are ON (means the illuminance level has fallen below the onLevel) and OFF (means the illuminance level has risen above the offLevel).
photocellOutputOn AttributeBoolean event None The photocell output has changed to ON.
applicationType AttributeString configuration None Application Type of the photocell depending on the use case. E.g.: ‘Presence detector’

3.11 Light Sensor

A Light Sensor function models the output of light sensor. This function is optional for both CMS and Gateway, but when supported the requirements in this section shall apply.

See the optionality and profiles information for the Light Sensor function

Light Sensor function’s attributes
ID Type Scope Unit Description
levelHighThreshold AttributeFloat configuration Illuminance Light level above which a levelTooHigh event is triggered.
levelLowThreshold AttributeFloat configuration Illuminance Light level below which a levelTooLow event is triggered.
lightLevel AttributeFloat measurement Illuminance Illuminance level.
levelTooHigh AttributeBoolean event None Indicates the light level is above the levelHighThreshold.
levelTooLow AttributeBoolean event None Indicates the light level is below the levelLowThreshold.
applicationType AttributeString configuration None Application Type of the light sensor depending on the use case. E.g.: ‘Day light detector’

3.12 Binary Sensor

A Binary Sensor function can be used to model any sensor that provides a digital, binary output. This function is optional for both CMS and Gateway, but when supported the requirements in this section shall apply.

See the optionality and profiles information for the Binary Sensor function

Binary Sensor function’s attributes
ID Type Scope Unit Description
level AttributeBinary measurement None Sensor Output level.
sensorOutputOn AttributeBoolean event None Indicates the sensor output changed to ON.
applicationType AttributeString configuration None Application Type of the binary sensor depending on the use case. E.g.: ‘Door open sensor’

3.13 Generic Sensor

A Generic Sensor function can be used to model any sensor that provides an analog or multilevel output. This function is optional for both CMS and Gateway, but when supported the requirements in this section shall apply.

See the optionality and profiles information for the Generic Sensor function

Generic Sensor function’s attributes
ID Type Scope Unit Description
levelHighThreshold AttributeFloat configuration None Threshold above which a levelTooHigh event is triggered.
levelLowThreshold AttributeFloat configuration None Threshold below which a levelTooLow event is triggered.
level AttributeFloat measurement None Sensor Output level.
levelTooHigh AttributeBoolean event None Indicates the sensor output level is above the levelHighThreshold.
levelTooLow AttributeBoolean event None Indicates the sensor output level is below the levelLowThreshold.
applicationType AttributeString configuration None Application Type of the generic sensor depending on the use case. E.g.: ‘Sound sensor’

3.14 Temperature Sensor

The Temperature Sensor function allows a CMS to monitor the temperature in a device and send events in case the value is above/below configurable thresholds.

See the optionality and profiles information for the Temperature Sensor function

Temperature Sensor function’s attributes
ID Type Scope Unit Description
temperatureHighThreshold AttributeFloat configuration DegreesCelcius Threshold above which a temperatureTooHigh event is triggered.
temperatureLowThreshold AttributeFloat configuration DegreesCelcius Threshold below which a temperatureTooLow event is triggered.
fireDetectionThreshold AttributeFloat configuration DegreesCelcius Threshold above which a fireDetected event is triggered.
temperature AttributeFloat measurement DegreesCelcius Output temperature.
temperatureTooHigh AttributeBoolean event None Indicates the output temperature is above the temperatureHighThreshold.
temperatureTooLow AttributeBoolean event None Indicates the output temperature is below the temperatureLowThreshold.
fireDetected AttributeBoolean event None Indicates a fire has been detected, based on the fireDetectionThreshold configuration or other method.
applicationType AttributeString configuration None Application Type of the temperature depending on the use case. E.g.: ‘Solar Battery Charger or Lamp’
minMeasuredTemperature AttributeFloat measurement DegreesCelcius The minimum value measured by the sensor since power ON or since measuredTemperatureSince.
maxMeasuredTemperature AttributeFloat measurement DegreesCelcius The maximum value measured by the sensor since power ON or since measuredTemperatureSince.
measuredTemperatureSince AttributeDateTime configuration None Indicates the date and time at which measuredTemperature is reset to zero. The Gateway may change this value with the actual one depending on implementation.

3.15 Humidity Sensor

The Humidity Sensor function allows a CMS to monitor the humidity in a device and send events in case the value is above/below configurable thresholds.

See the optionality and profiles information for the Humidity Sensor function

Humidity Sensor function’s attributes
ID Type Scope Unit Description
humidityLowThreshold AttributeFloat configuration Percent Threshold below which a humidityTooLow event is triggered.
humidityHighThreshold AttributeFloat configuration Percent Threshold above which a humidityTooHigh event is triggered.
humidity AttributeFloat measurement Percent Output humidity.
humidityTooLow AttributeBoolean event None Indicates the output humidity is below the humidityLowThreshold.
humidityTooHigh AttributeBoolean event None Indicates the output humidity is above the humidityHighThreshold.
applicationType AttributeString configuration None Application Type of the humidity sensor depending on the use case. E.g.: ‘Air Humidity Sensor’

3.16 Particulate Matter Sensor

The Particulate Matter Sensor function allows a CMS to monitor the PM10, PM2.5 and PM1 in a device and send events in case the value is above/below configurable thresholds.

See the optionality and profiles information for the Particulate Matter Sensor function

Particulate Matter Sensor function’s attributes
ID Type Scope Unit Description
pm1HighThreshold AttributeFloat configuration MicrogramsPerCubicMeter Threshold (micrograms/m3) above which a pm1TooHigh event is triggered.
pm2-5HighThreshold AttributeFloat configuration MicrogramsPerCubicMeter Threshold (micrograms/m3) above which a pm2-5TooHigh event is triggered.
pm10HighThreshold AttributeFloat configuration MicrogramsPerCubicMeter Threshold (micrograms/m3) above which a pm10TooHigh event is triggered.
pm1 AttributeFloat measurement MicrogramsPerCubicMeter Level of pm1 measured by the sensor. (micrograms/m3)
pm2-5 AttributeFloat measurement MicrogramsPerCubicMeter Level of pm2-5 measured by the sensor. (micrograms/m3)
pm10 AttributeFloat measurement MicrogramsPerCubicMeter Level of pm10 measured by the sensor. (micrograms/m3)
pm1TooHigh AttributeBoolean event None Indicates the output pm1 is above the pm1HighThreshold.
pm2-5TooHigh AttributeBoolean event None Indicates the output pm2-5 is above the pm2-5HighThreshold.
pm10TooHigh AttributeBoolean event None Indicates the output pm10 is above the pm10HighThreshold.
applicationType AttributeString configuration None Application Type of the particulate matter sensor depending on the use case. E.g.: ‘Air Quality Sensor’
pm1-24hAverage AttributeFloat measurement MicrogramsPerCubicMeter Average level of pm1 measured by the sensor during the last 24h. (micrograms/m3)
pm2-5-24hAverage AttributeFloat measurement MicrogramsPerCubicMeter Average level of pm2.5 measured by the sensor during the last 24h. (micrograms/m3)
pm10-24hAverage AttributeFloat measurement MicrogramsPerCubicMeter Average level of pm10 measured by the sensor during the last 24h. (micrograms/m3)

3.17 Presence Sensor

The Presence Sensor function allows a CMS to detect presence. This function may be used in Parking Place detectors as well as in dynamic outdoor lighting scenario.

See the optionality and profiles information for the Presence Sensor function

Presence Sensor function’s attributes
ID Type Scope Unit Description
presenceStatus AttributeBoolean measurement None Presence status.
presenceStatusChanged AttributeBoolean event None Indicates the presence status changed.
applicationType AttributeString configuration None Application Type of the presence sensor depending on the use case. E.g.: ‘Presence detector’

3.18 Movement Sensor

The Movement Sensor function allows a CMS to detect movement. This function may be used in a Waste Container sensor to detect that container gets emptied or is not in the proper position, as well as in asset tracking applications. [DEPRECATED: This function has been deprecated and it will be removed in the next MAJOR release. Please use the new LocationSensorFunction instead]

See the optionality and profiles information for the Movement Sensor function

Movement Sensor function’s attributes
ID Type Scope Unit Description
movementThreshold AttributeFloat configuration Meters The distance of movement, in meters, relative to the location from the last movementDetected event.
movementDetected AttributeBoolean measurement None Indicates the location changed.
notInProperPosition AttributeBoolean event None Indicates the device is not in its correct position.

3.19 Location Sensor

The Location Sensor Function is used to indicate that an object has changed position attributes configurable by the CMS or based on internal setup of the vendor. For example, a specific location (latitude, longitude) of a device could be defined by the vendor. If the device is equipped with a GPS, it could send a specific event indicating that its position is different to the one defined by the CMS. We might also want to let the configuration to the vendor itself and simply define events notifying the CMS that the default configuration has changed. For example, a garbage bin could have its location defined based on a sensor placed on the floor. If the bin is not above this sensor, the vendor will trigger an event. In this last case, the CMS does not need to configure anything.

See the optionality and profiles information for the Location Sensor function

Location Sensor function’s attributes
ID Type Scope Unit Description
expectedLocation AttributeLocation configuration None Nominal location of the device.
locationChangedThreshold AttributeFloat configuration Meters Distance (meters)
location AttributeLocation measurement None Location of the device.
locationChanged AttributeBoolean event None Triggered when the difference between location and expectedLocation is above locationChangedThreshold.
uncertainty AttributeFloat measurement Meters The uncertainty indicates the radius of a circular area in meters, reported by the positioning system. The circular area is used to describe uncertainty about a point for coordinates in a two-dimensional coordinate reference systems (CRS). The center point of a circular area is specified by using the Latitude and the Longitude Resources.
compassDirection AttributeInteger measurement Degrees The measured compass direction. 0..360 deg.
velocity AttributeVelocity measurement None The instantaneous velocity of the device, as defined in [3GPP-TS_23.032]. The AttributeVelocity contains horizontal speed, bearing, vertical speed, direction and uncertainty.
speed AttributeFloat measurement MetersPerSecond The instantaneous speed is the time rate of change in position of the device without regard for direction: the scalar component of velocity in 3d. (m/s)
applicationType AttributeString configuration None Application Type of the location sensor depending on the use case. E.g.: ‘Pole Location’

3.20 Accelerometer

The Accelerometer Function is used to indicate that an object has had an impact with another object and to report its acceleration. For example, a light controller placed on a light pole and equipped with an accelerometer can be used to detect an impact (car accident on the light pole).

See the optionality and profiles information for the Accelerometer function

Accelerometer function’s attributes
ID Type Scope Unit Description
impactDetectedAccelerationThreshold AttributeFloat configuration g-force Threshold for acceleration above which impactDetected is triggered (g).
accelerationSamplingPeriod AttributeFloat configuration Seconds In seconds.
accelerationX AttributeFloat measurement g-force Maximum acceleration on the X axis (g) over accelerationSamplingPeriod.
accelerationY AttributeFloat measurement g-force Maximum acceleration on the Y axis (g) over accelerationSamplingPeriod.
accelerationZ AttributeFloat measurement g-force Maximum acceleration on the Z axis (g) over accelerationSamplingPeriod.
acceleration AttributeFloat measurement g-force Maximum acceleration of the device (g) over accelerationSamplingPeriod.
impactDetected AttributeBoolean event None Indicates that the acceleration is above impactDetectedAccelerationThreshold.
applicationType AttributeString configuration None Application Type of the accelerometer depending on the use case. E.g.: ‘Crash detector’

3.21 Orientation

The Orientation function is used to indicate that an object has changed orientation based on attributes configurable by the CMS or based on internal setup of the vendor. The target orientation of the object could be configured by the CMS or could be handled by the vendor. In the latter case, the configuration is let to the vendor itself and events are triggered depending on internal configuration.

See the optionality and profiles information for the Orientation function

Orientation function’s attributes
ID Type Scope Unit Description
expectedOrientation AttributeOrientation configuration None Nominal orientation of the device.
orientationChangedThreshold AttributeOrientation configuration None Threshold above which orientationChanged is triggered.
orientation AttributeOrientation measurement None Orientation of the device.
orientationChanged AttributeBoolean event None Triggered when orientation differs from expectedOrientation by more than orientationChangedThreshold on any angle, or when the device determines itself that its orientation has changed.
applicationType AttributeString configuration None Application Type of the orientation depending on the use case. E.g.: ‘Orientation change detector’

3.22 Battery Level Sensor

The Battery Level Sensor function allows to measure the charge of the battery, monitor the battery and send events in case the value is above/below configurable thresholds.

See the optionality and profiles information for the Battery Level Sensor function

Battery Level Sensor function’s attributes
ID Type Scope Unit Description
powerSource AttributePowerSource configuration None The power source of battery. The value can be Mains, Battery or Other
batteryLevelLowThreshold AttributeFloat configuration Percent Threshold below which a batteryLevelTooLow event is triggered.
batteryLevel AttributeFloat measurement Percent Battery level.
batteryLevelTooLow AttributeBoolean event None Indicates the battery level is below the batteryLevelLowThreshold.
applicationType AttributeString configuration None Application Type of the battery level sensor depending on the use case. E.g.: ‘Solar Battery’

3.23 Filling Level Sensor

The Filling Level Sensor function allows to measure how full a container is and send events in case the value is above/below configurable thresholds.

See the optionality and profiles information for the Filling Level Sensor function

Filling Level Sensor function’s attributes
ID Type Scope Unit Description
levelHighThreshold AttributeFloat configuration Meters Threshold (m) above which a fillingHeight event is triggered.
containerHeight AttributeFloat configuration Meters Container height (m).
containerVolume AttributeFloat configuration CubicMeters Container volume (m^3).
fillingHeight AttributeFloat measurement Meters Filling container height (m).
fillingPercentage AttributePercent measurement Percent Filling percentage.
containerFull AttributeBoolean event None Indicates the container filling height is above levelHighThreshold.
contentsType AttributeContentsType configuration None Indicates de type of contents in the container. Some technologies, such as ultrasonic sensors, need this information in order to measeure accuratelly. Possible values are: mixed waste, organic, paper, plastics, glass, liquid, clothing, electronics, metal or other. If other is selected, then contentsOtherType shall be used.
contentsOtherType AttributeString configuration None Type of contents if it is not included in the Enum list of contents for contentsType.
applicationType AttributeString configuration None Application Type of the filling level sensor depending on the use case. E.g.: ‘Container Filling Level’

3.24 Solar Battery Charger

A solar battery charger is used to charge a battery with solar energy. Typical use cases are energy demanding off-grid applications like solar lighting, solar vehicle charging (cars and bikes), public transit information, traffic control, public security (CCTV) and many more.

See the optionality and profiles information for the Solar Battery Charger function

Solar Battery Charger function’s attributes
ID Type Scope Unit Description
inputVoltage AttributeFloat measurement Volts Measured DC voltage of the charger input (V).
inputCurrent AttributeFloat measurement Amperes Measured DC current of the charger input (A).
outputVoltage AttributeFloat measurement Volts Output voltage (V).
outputCurrent AttributeFloat measurement Amperes Output current (A).
chargerTemperature AttributeFloat measurement DegreesCelcius Measured temperature of the charger circuit (C). [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new TemperatureSensorFunction.temperature with applicationType=‘Charger’ instead]
PVTemperature AttributeFloat measurement DegreesCelcius Measured temperature of the attached photovoltaic module (C). [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new TemperatureSensorFunction.temperature with applicationType=‘PVT’ instead]
accumulatedEnergy AttributeFloat measurement KiloWattHours Accumulated energy yield since accumulatedSince (Wh).
startChargeInputVoltage AttributeFloatKVPArray configuration None Configuration parameter to set input voltage thresholds at different temperatures at which the battery charger shall start charging the battery (V, C). The values are stored as a list of KVPs (Key-Value Pair), where the key is the temperature and the value is the voltage.
endChargeInputVoltage AttributeFloatKVPArray configuration None Configuration parameter to set input voltage thresholds at different temperatures at which the battery charger shall cease charging the battery (V, C). The values are stored as a list of KVPs (Key-Value Pair), where the key is the temperature and the value is the voltage.
highTemperatureThreshold AttributeFloat configuration DegreesCelcius Threshold above which the highTemperature event is triggered (C). [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new TemperatureSensorFunction.temperatureTooHighThreshold instead]
lowTemperatureThreshold AttributeFloat configuration DegreesCelcius Threshold above which the lowTemperature event is triggered (C). [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new TemperatureSensorFunction.temperatureTooLowThreshold instead]
highPowerThreshold AttributeFloat configuration KiloWatt Threshold above which the highPower event is triggered (kW).
accumulatedSince AttributeDateTime configuration None Indicates the date and time at which accumulatedEnergy is reset to zero. The Gateway may change this value with the actual one depending on implementation.
highTemperature AttributeBoolean event None Indicates the measured temperature is above the high temperature threshold. [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new TemperatureSensorFunction.temperatureTooHigh instead]
lowTemperature AttributeBoolean event None Indicates the measured temperature is below the low temperature threshold. [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new TemperatureSensorFunction.temperatureTooLow instead]
highPower AttributeBoolean event None Indicates the power exceeds highPowerThreshold.
charging AttributeBoolean event None Indicates whether the battery is being charged.
applicationType AttributeString configuration None Application Type of the solar battery charger depending on the use case. E.g.: ‘Lamp Battery’

3.25 Battery Management System

A battery management system is used to monitor the charging and discharging of a battery and protect the battery. Typical use cases are (off-grid) applications like solar lighting, solar vehicle charging (cars and bikes), public transit information, traffic control, public security (CCTV) and many more, where the battery is charged and discharged on a regular basis.

See the optionality and profiles information for the Battery Management System function

Battery Management System function’s attributes
ID Type Scope Unit Description
batteryChemistry AttributeString configuration None Attribute to define the battery chemistry. (e.g.: Lead Acid, Lithium-Iron-Phosphate (LiFePO4), Nickel-Metal-Hydrid (NiMH), Lithium-Titanate-Oxide (LTO), …)
nominalVoltage AttributeFloat configuration Volts Attribute to set the nominal voltage of the battery in V (at room temperature). This can be used to calculate the capacity and to configure the BMS.
nominalCapacity AttributeFloat configuration AmperesPerHour Attribute to set the nominal capacity of the battery in Ah (at room temperature).
batteryVoltage AttributeFloat measurement Volts Measurement of the battery voltage in V.
batteryCurrent AttributeFloat measurement Amperes Measurement of the battery current in A. This value can be negative due to polarity.
batteryLevel AttributeFloat measurement Percent Percentage.
estimatedCapacity AttributeFloat measurement AmperesPerHour This attribute gives an estimated remaining capacity of the battery in Ah. This depends very much on the wear and age of the battery.
temperature AttributeFloat measurement DegreesCelcius Temperature at the battery in C. [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new TemperatureSensorFunction.temperature with applicationType=‘Battery’ instead]
batteryEOCVoltageTemperatureMap AttributeFloatKVPArray configuration Volts End of charge voltages (V) of the battery for various temperatures (C). The values are stored as a list of KVPs (Key-Value Pair), where the key is the temperature and the value is the voltage.
batteryEODVoltageTemperatureMap AttributeFloatKVPArray configuration Volts End of discharge voltages (V) of the battery for various temperatures (C). The values are stored as a list of KVPs (Key-Value Pair), where the key is the temperature and the value is the voltage.
batteryFullThreshold AttributeFloat configuration AmperesPerHour Level threshold to indicate that the battery is full.
batteryEmptyThreshold AttributeFloat configuration AmperesPerHour Level threshold to indicate that the battery is empty.
overCurrentChargeThreshold AttributeFloat configuration Amperes Maximum charge current threshold (A).
overCurrentDischargeThreshold AttributeFloat configuration Amperes Maximum discharge current threshold (A).
highTemperatureThreshold AttributeFloat configuration DegreesCelcius Threshold above which the highTemperature event is triggered (C). [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new TemperatureSensorFunction.temperatureTooHighThreshold instead]
batteryFull AttributeBoolean event None Indicates that the battery is full.
batteryEmpty AttributeBoolean event None Indicates that the battery is empty.
overCurrentCharge AttributeBoolean event None Indicates that the charge current is higher than the threshold.
overCurrentDischarge AttributeBoolean event None Indicates that the discharge current is higher than the threshold.
highTemperature AttributeBoolean event None Indicates that the measured temperature is higher than the threshold. [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new TemperatureSensorFunction.temperatureTooHigh instead]
applicationType AttributeString configuration None Application Type of the battery management system depending on the use case. E.g.: ‘Lamp Battery’

3.26 Traffic Counter

The Traffic Counter Function is used to provide statistics on the number of vehicles passing on the road. It allows to have the number of pedestrians, bicycles, cars or trucks for a certain period of time that is configurable by the CMS. It also allows to count the number of vehicles using diesel or petrol.

See the optionality and profiles information for the Traffic Counter function

Traffic Counter function’s attributes
ID Type Scope Unit Description
roadUserNumber AttributeInteger measurement None Number of road users of the specified type detected over the sampling period.
accumulatedRoadUserNumber AttributeInteger measurement None measurement Number of road users of the specified type detected since accumulatedSince.
roadUser AttributeRoadUser configuration None Type of road user (pedestrian, bicycle, motorcycle, car, truck, diesel vehicle, petrol vehicle, electric vehicle, scooter, others).
accumulatedSince AttributeDateTime configuration None Indicates the date and time at which accumulatedRoadUserNumber is reset to zero. The Gateway may change this value with the actual one depending on implementation.
heavyTrafficDetected AttributeBoolean event None Triggered if the traffic measured over the sampling period is above heavyTrafficDetectedThreshold.
heavyTrafficDetectedThreshold AttributeInteger configuration None Threshold above which heavyTrafficDetected is triggered.
trafficSamplingPeriod AttributeInteger configuration Seconds Used by heavyTrafficDetected and roadUserNumber. In seconds.
averageSpeed AttributeInteger measurement KilometersPerHour Average speed measured on the road users of the specified type during the last sampling period (km/h)
averageDistance AttributeInteger measurement Meters Average distance between two road users of the specified type during the last sampling period (m)
speedLimitThreshold AttributeInteger configuration KilometersPerHour Speed limit threshold used to calculate the percentage of road users of the specified type above speed limit. (km/h)
percentageAboveSpeedLimit AttributeInteger measurement Percent Percentage of road users of the specified type driving above speed limit detected over the sampling period.
applicationType AttributeString configuration None Application Type of the traffic counter depending on the use case. E.g.: ‘People counter; Vehicle counter’
actualUserNumber AttributeInteger measurement None Number of road users currently identified by the device
sensorType AttributeString configuration None Type of sensor (e.g: Bluetooth beacon, WIFI detector)
dailyRoadUserNumber AttributeInteger measurement None Cumulated number of road users detected by the device since beginning of the day.
minSpeed AttributeInteger configuration KilometersPerHour Minimum cutoff speed under which traffic is not measured (km/h)
maxSpeed AttributeInteger configuration KilometersPerHour Maximum cutoff speed above which traffic is not measured (km/h)
sensorSensitivity AttributeInteger configuration Percent Sensor sensitivity (%) to reduce sensor detection range. This value must be the same when multiple instances of the function are used for the same physical sensor.
trafficDirection AttributeTrafficDirection configuration None Specifies whether the sensor measures only incoming traffic, outgoing traffic, or both. (Direction 1, Direction 2, Both)

3.27 Fluid Level Sensor

The Fluid Level Sensor function allows to collect data and events about fluid levels. It could be used to measure fluid levels in channels, lakes, containers, etc.

See the optionality and profiles information for the Fluid Level Sensor function

Fluid Level Sensor function’s attributes
ID Type Scope Unit Description
fluidLevelTooHighThreshold AttributeFloat configuration Meters Threshold above which fluidLevelTooHighThreshold is triggered. In meters.
fluidLevelTooLowThreshold AttributeFloat configuration Meters Threshold below which fluidLevelTooLowThreshold is triggered. In meters.
distanceSensorBottom AttributeFloat configuration Meters Distance between the sensor and the bottom of the channel, lake, container, etc. In meters.
fluidLevel AttributeFloat measurement Meters Fluid level in meters.
fluidLevelTooHigh AttributeBoolean event None Triggered when fluidLevel is above fluidLevelTooHighThreshold.
fluidLevelTooLow AttributeBoolean event None Triggered when fluidLevel is below fluidLevelTooLowThreshold.
applicationType AttributeString configuration None Application Type of the fluid level sensor depending on the use case. E.g.: ‘Lake level sensor’

3.28 Waste Container

The Waste Container function allows to log when the container is collected and send events in case the date is above a configurable threshold. Additionally it sends events when the contents or container are tampered.

See the optionality and profiles information for the Waste Container function

Waste Container function’s attributes
ID Type Scope Unit Description
lastCollectionDate AttributeDateTime measurement None Last collection date.
collectionLateThreshold AttributeInteger configuration Days Threshold (days) since last collection date above which a collection late event is triggered.
collectionLate AttributeBoolean event None Indicates that the number of days occured since the lastCollectionDate is over the collectionLateThreshold.
containerTampered AttributeBoolean event None Indicates that the container is being tampered, or some parts are being removed.
contentsTampered AttributeBoolean event None Indicates that the contents are being tampered or stolen.
wasteType AttributeContentsType configuration None Indicates de type of waste in the container. Possible values are: mixed waste, organic, paper, plastics, glass, liquid, clothing, electronics, metal or other. If other is selected, then wasteOtherType shall be used.
wasteOtherType AttributeString configuration None Type of waste if it is not included in the Enum list of contents for wasteType.
applicationType AttributeString configuration None Application Type of the waste container depending on the use case. E.g.: ‘Waste container’

3.29 pH Sensor

The pH Sensor allows to measure the pH and sends events if the value is above/below the configured thresholds.

See the optionality and profiles information for the pH Sensor function

pH Sensor function’s attributes
ID Type Scope Unit Description
pH AttributeFloat measurement None pH value.
pHHighLevelThreshold AttributeFloat configuration None Threshold above which a pHTooHigh (too Alkaline) event is triggered.
pHLowLevelThreshold AttributeFloat configuration None Threshold below which a pHTooLow (too Acidic) event is triggered.
pHTooHigh AttributeBoolean event None Indicates the pH measure is above the pHHighLevelThreshold, that is too alkaline.
pHTooLow AttributeBoolean event None Indicates the pH measure is below the pHLowLevelThreshold, that is too acidic.
applicationType AttributeString configuration None Application Type of the pH sensor depending on the use case. E.g.: ‘Hazardous Waste Detector’

3.30 Weight Sensor

The Weight Sensor allows to measure the weight and sends an event if the value is above/below the thresholds

See the optionality and profiles information for the Weight Sensor function

Weight Sensor function’s attributes
ID Type Scope Unit Description
weightLowThreshold AttributeFloat configuration Kilograms Threshold (in kg) below which a weightTooLow event is triggered.
weightHighThreshold AttributeFloat configuration Kilograms Threshold (in kg) above which a weightTooHigh event is triggered.
weight AttributeFloat measurement Kilograms Output weight in kg.
weightTooLow AttributeBoolean event None Indicates the output weight is below the weightLowThreshold.
weightTooHigh AttributeBoolean event None Indicates the output weight is above the weightHighThreshold.
applicationType AttributeString configuration None Application Type of the weight sensor depending on the use case. E.g.: ‘Waste Weight Detector’

3.31 Gas Sensor

The Gas Sensor function allows to measure the gas concentration and sends events if the level is above the configured thresholds.

See the optionality and profiles information for the Gas Sensor function

Gas Sensor function’s attributes
ID Type Scope Unit Description
gasConcentration AttributeFloat measurement PartsPerMillion Gas concentration (ppm)
gasHighConcentrationThreshold AttributeFloat configuration PartsPerMillion Threshold (ppm) above which a gasConcentrationTooHigh event is triggered.
gasConcentrationTooHigh AttributeBoolean event None Indicates that the gasConcentration is above the gasHighConcentrationThreshold.
gasName AttributeGasName configuration None Type of gas: CO, CO2, O2, O3, NO, NO2, SO2, NH3, CH4, H2, H2S, HCl, HCN, PH3, ETO, Other. If Other is selected, then gasOtherName shall be used.
gasOtherName AttributeString configuration None Type of gas if it is not included in the Enum list of gases for gasName
applicationType AttributeString configuration None Application Type of the gas sensor depending on the use case. E.g.: ‘Waste Gas Detector’
gasConcentration1hAverage AttributeFloat measurement PartsPerMillion Average concentration of gas measured by the sensor during the last 1 hour. (ppm)
gasConcentration8hAverage AttributeFloat measurement PartsPerMillion Average concentration of gas measured by the sensor during the last 8 hours. (ppm)

3.32 Segment Monitor

The Segment Monitor function enables monitoring of segment parameters. Multiple segment monitor functions may be implemented by a single device.

See the optionality and profiles information for the Segment Monitor function

Segment Monitor function’s attributes
ID Type Scope Unit Description
applicationType AttributeString configuration None Application Type of the segment monitor depending on the use case. E.g.: “Road Lighting, Architecture Lighting”
segmentReference AttributeString configuration None Reference of the segment monitor depending on the use case. E.g.: “Segment A1”
actuatorReference AttributeString configuration None Function ID of the actuator, located in the same device, whose effect is being monitored by this function. e.g.: fLampActuatorId_1 or fGenericActuatorId_2
numberOfLoads AttributeInteger configuration None Number of loads being monitored by the segment monitor function.
switchingErrorOn AttributeBoolean event None Indicates error in switching circuit. For instance, if a contactor or relay is used, it may be stuck in ON position.
switchingErrorOff AttributeBoolean event None Indicates error in switching circuit. For instance, if a contactor or relay is used, it may be stuck in OFF position.
leakageDetected AttributeBoolean event None Indicates that an earth leakage fault has been detected. [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new CabinetMonitorFunction.leakageDetected instead]
cabinetDoorOpen AttributeBoolean event None Cabinet door is open. [DEPRECATED: This attribute has been deprecated and it will be removed in the next MAJOR release. Please use the new CabinetMonitorFunction.cabinetDoorOpen instead]
circuitBreakerTripped AttributeBoolean event None Indicates that the circuit breaker has tripped
localOverride AttributeLocalOverride event None Indicates that there is a local override (ON, OFF) or no override
actualState AttributeBinary measurement None This attribute should reflect the physical relay state (ON, OFF) of the source as much as possible. It may be calculated or measured, depending on the specific ODN implementation, which is outside the scope of this specification.

3.33 Noise Monitoring Sensor

This sensor function enables monitoring basic noise data.

See the optionality and profiles information for the Noise Monitoring Sensor function

Noise Monitoring Sensor function’s attributes
ID Type Scope Unit Description
noiseHighThreshold AttributeFloat configuration Decibels Threshold above which a noiseTooHigh event is triggered. (dB)
noise AttributeFloat measurement Decibels Output noise. (dB)
noiseTooHigh AttributeBoolean event None Indicates the output noise is above the noiseHighThreshold.
applicationType AttributeString configuration None Application Type of the noise depending on the use case. E.g.: ‘Street noise sensor’
minMeasuredNoise AttributeFloat measurement Decibels The minimum value measured by the sensor since power ON or since measuredNoiseSince. (dB)
maxMeasuredNoise AttributeFloat measurement Decibels The maximum value measured by the sensor since power ON or since measuredNoiseSince. (dB)
measuredNoiseSince AttributeDateTime configuration None Indicates the date and time at which measuredNoise is reset to zero. The Gateway may change this value with the actual one depending on implementation.
abnormalNoiseDetected AttributeBoolean event None Indicates that an abnormal noise is detected
typeOfNoise AttributeString measurement None Indicates the type of sound of the abnormalNoiseDetected event. E.g.: gunShot, alarm, carCrash, ..

3.34 Atmospheric Sensor

This sensor function enables monitoring basic atmospheric data such as barometric pressure, humidity, and temperature. This function complies with WMO standards as reported in the ‘Guide to Instruments and Methods of Observation (WMO-No. 8) / Volume I –Measurement of Meteorological Variables’

See the optionality and profiles information for the Atmospheric Sensor function

Atmospheric Sensor function’s attributes
ID Type Scope Unit Description
airTemperature AttributeFloat measurement DegreesCelcius Temperature (°C)
feelsLikeTemperature AttributeFloat measurement DegreesCelcius Feels like temperature, which take into account the cooling and heating effects of wind and humidity on the human body (°C)
relativeHumidity AttributeFloat measurement Percent Relative humidity (%)
dewPoint AttributeFloat measurement DegreesCelcius Temperature of dew point (°C)
atmosphericPressure AttributeFloat measurement Hectopascal Atmospheric pressure normalized to sea level (hPa)
applicationType AttributeString configuration None Application Type of the atmospheric sensor depending on the use case. E.g.: ‘Weather atmospheric sensor’

3.35 Wind Sensor

This sensor function enables monitoring wind speed and direction. This function complies with WMO standards as reported in the ‘Guide to Instruments and Methods of Observation (WMO-No. 8) / Volume I –Measurement of Meteorological Variables’

See the optionality and profiles information for the Wind Sensor function

Wind Sensor function’s attributes
ID Type Scope Unit Description
windSpeed AttributeInteger measurement MetersPerSecond Wind speed (m/s)
windDirectionString AttributeWindDirection measurement None Wind direction (N, NE, E, SE, S, SW, W, NW)
windDirection AttributeInteger measurement Degrees Wind direction in degrees (Relative to True north)
windGust AttributeInteger measurement MetersPerSecond Wind gust speed (m/s)
windGustDirection AttributeInteger measurement Degrees Wind gust direction in degrees (Relative to True north)
maxWindGust AttributeInteger measurement MetersPerSecond Max wind gust speed (m/s) measured since maxWindGustSince
maxWindGustSince AttributeDateTime configuration None Indicates the date and time at which maxWindGust is reset to zero. The Gateway may change this value with the actual one depending on implementation.
applicationType AttributeString configuration None Application Type of the wind sensor depending on the use case. E.g.: ‘Weather wind sensor’

3.36 Precipitation Sensor

This sensor function enables monitoring precipitation, defined as the liquid or solid products of the condensation of water vapour falling from clouds, in the form of rain, drizzle, snow, snow grains, snow pellets, hail and ice pellets; or falling from clear air in the form of diamond dust. This function complies with WMO standards as reported in the ‘Guide to Instruments and Methods of Observation (WMO-No. 8) / Volume I –Measurement of Meteorological Variables’

See the optionality and profiles information for the Precipitation Sensor function

Precipitation Sensor function’s attributes
ID Type Scope Unit Description
precipitationRate AttributeInteger measurement MillimetersPerHour Intensity of precipitation (mm/h)
accumulatedPrecipitation AttributeInteger measurement MillimetersPerHour Accumulated precipitation since accumulatedPrecipitationSince (mm/h)
accumulatedPrecipitationSince AttributeDateTime configuration None Indicates the date and time at which accumulatedPrecipitation is reset to zero. The Gateway may change this value with the actual one depending on implementation.
applicationType AttributeString configuration None Application Type of the precipitation sensor depending on the use case. E.g.: ‘Weather precipitation sensor’

3.37 Sky Sensor

This sensor function enables monitoring of other atmospheric phenomena. This function complies with WMO standards as reported in the ‘Guide to Instruments and Methods of Observation (WMO-No. 8) / Volume I –Measurement of Meteorological Variables’

See the optionality and profiles information for the Sky Sensor function

Sky Sensor function’s attributes
ID Type Scope Unit Description
cloudiness AttributeInteger measurement Percent Cloud cover of the sky (%)
solarDirectRadiation AttributeFloat measurement WattsPerSquareMeter Total solar irradiance (W/m2)
visibility AttributeInteger measurement Meters Visibility (m)
applicationType AttributeString configuration None Application Type of the sky sensor depending on the use case. E.g.: ‘Weather sky sensor’

3.38 Gully Sensor

The Gully Sensor measures properties associated with street drains or gullies.

See the optionality and profiles information for the Gully Sensor function

Gully Sensor function’s attributes
ID Type Scope Unit Description
overfull AttributeBoolean event None Indicates that the gully is overfull
levelWarning AttributeBoolean event None Indicates that the water level is problematic.
grillOpened AttributeBoolean event None Indicates that the gully grill is opened
siltLevel AttributeFloat measurement Percent Level of silt (%)
applicationType AttributeString configuration None Application Type of the gully sensor depending on the use case. E.g.: ‘Street Gully sensor’

3.39 Water Flow Sensor

The water flow sensor function measures the water flow rate.

See the optionality and profiles information for the Water Flow Sensor function

Water Flow Sensor function’s attributes
ID Type Scope Unit Description
flowRate AttributeFloat measurement CubicMetersPerSecond Rate of water flow (m3/s)
flowRateTooHighThreshold AttributeFloat configuration CubicMetersPerSecond Threshold above which a flowRateTooHigh event is triggered (m3/s).
flowRateTooLowThreshold AttributeFloat configuration CubicMetersPerSecond Threshold below which a flowRateTooLow event is triggered (m3/s).
flowRateTooHigh AttributeBoolean event None Indicates the flowRate measure is above the flowRateTooHighThreshold.
flowRateTooLow AttributeBoolean event None Indicates the flowRate measure is below the flowRateTooLowThreshold.
maxFlowRate AttributeFloat measurement CubicMetersPerSecond Max flow rate value since flowRateSince (m3/s).
minFlowRate AttributeFloat measurement CubicMetersPerSecond Min flow rate value since flowRateSince (m3/s).
flowRateSince AttributeDateTime configuration None Sets the date and time at which max and min flow rates are reset to zero
applicationType AttributeString configuration None Application Type of the water flow sensor depending on the use case. E.g.: ‘Street water flow sensor’

3.40 Water Quality Sensor

The water quality sensor function measures the quality of the water in the drinkable water distribution network, in water tanks or in lakes and rivers.

See the optionality and profiles information for the Water Quality Sensor function

Water Quality Sensor function’s attributes
ID Type Scope Unit Description
pH AttributeFloat measurement None Current or last value of the pH measured by the sensor.
chlorine AttributeFloat measurement PartsPerMillion Current or last value of the chlorine measured by the sensor (ppm)
orp AttributeFloat measurement Volts Current or last value of the oxidation reduction potential (ORP) measured by the sensor (V)
totalDissolvedGas AttributeFloat measurement PartsPerMillion Current or last value of the dissolved gas (TDG) measured by the sensor (ppm).
dissolvedOxygen AttributeFloat measurement PartsPerMillion Current or last value of the dissolved oxygen measured by the sensor (ppm).
turbidity AttributeFloat measurement NephelometricTurbidityUnit Current or last value of the turbidity measured by the sensor using the Nephelometric Turbidity Unit (NTU).
conductivity AttributeFloat measurement SiemenPerMeter Current or last value of the conductivity measured by the sensor (S/m).
conductance AttributeFloat measurement SiemenPerMeter Current or last value of the conductance measured by the sensor (S/m).
totalSuspendedSolids AttributeFloat measurement MilligramsPerLiter Current or last value of the TSS measured by the sensor (mg/l).
totalDissolvedSolids AttributeFloat measurement MilligramsPerLiter Current or last value of the TDS measured by the sensor (mg/l).
salinity AttributeFloat measurement PartsPerThousand Current or last value of the salinity measured by the sensor (ppt).
NO3 AttributeFloat measurement MilligramsPerLiter Current or last value of NO3 measured by the sensor (mg/l).
NH3 AttributeFloat measurement MilligramsPerLiter Current or last value of NH3 measured by the sensor (mg/l).
NH4 AttributeFloat measurement MilligramsPerLiter Current or last value of NH4 measured by the sensor (mg/l).
pHTooHigh AttributeBoolean event None Indicates the pH measure is above the phTooHighThreshold.
pHTooLow AttributeBoolean event None Indicates the pH measure is below the phTooLowThreshold.
pHTooHighThreshold AttributeFloat configuration None Threshold above which a pHTooHigh event is triggered.
pHTooLowThreshold AttributeFloat configuration None Threshold below which a pHTooLow event is triggered.
chlorineTooHigh AttributeBoolean event None Indicates the chlorine measure is above the chlorineTooHighThreshold.
chlorineTooHighThreshold AttributeFloat configuration PartsPerMillion Threshold above which a chlorineTooHigh event is triggered. (ppm)
orpTooLow AttributeBoolean event None Indicates the orp measure is below the orpTooLowThreshold.
orpTooLowThreshold AttributeFloat configuration Volts Threshold below which a orpTooLow event is triggered. (V)
totalDissolvedGasTooHigh AttributeBoolean event None Indicates the totalDissolvedGas measure is above the totalDissolvedGasTooHighThreshold.
totalDissolvedGasTooLow AttributeBoolean event None Indicates the totalDissolvedGas measure is below the totalDissolvedGasTooLowThreshold.
totalDissolvedGasTooHighThreshold AttributeFloat configuration PartsPerMillion Threshold above which a totalDissolvedGasTooHigh event is triggered.
totalDissolvedGasTooLowThreshold AttributeFloat configuration PartsPerMillion Threshold below which a totalDissolvedGasTooLow event is triggered.
dissolvedOxygenTooLow AttributeBoolean event None Indicates the dissolvedOxygen measure is below the dissolvedOxygenTooLowThreshold.
dissolvedOxygenTooLowThreshold AttributeFloat configuration PartsPerMillion Threshold below which a dissolvedOxygenTooLow event is triggered.
turbidityTooHigh AttributeBoolean event None Indicates the turbidity measure is above the turbidityTooHighThreshold.
turbidityTooHighThreshold AttributeFloat configuration NephelometricTurbidityUnit Threshold above which a turbidityTooHigh event is triggered. (NTU)
conductivityTooHigh AttributeBoolean event None Indicates the conductivity measure is above the conductivityTooHighThreshold.
conductivityTooHighThreshold AttributeFloat configuration SiemenPerMeter Threshold above which a conductivityTooHigh event is triggered. (S/m)
conductanceTooHigh AttributeBoolean event None Indicates the conductance measure is above the conductanceTooHighThreshold.
conductanceTooHighThreshold AttributeFloat configuration SiemenPerMeter Threshold above which a conductanceTooHigh event is triggered. (S/m)
totalSuspendedSolidsTooHigh AttributeBoolean event None Indicates the totalSuspendedSolids measure is above the totalSuspendedSolidsTooHighThreshold.
totalSuspendedSolidsTooHighThreshold AttributeFloat configuration MilligramsPerLiter Threshold below which a totalSuspendedSolidsTooHigh event is triggered. (mg/l)
totalDissolvedSolidsTooHigh AttributeBoolean event None Indicates the totalDissolvedSolids measure is above the totalDissolvedSolidsTooHighThreshold.
totalDissolvedSolidsTooHighThreshold AttributeFloat configuration MilligramsPerLiter Threshold below which a totalDissolvedSolidsTooHigh event is triggered. (mg/l)
salinityTooHigh AttributeBoolean event None Indicates the salinity measure is above the salinityTooHighThreshold.
salinityTooLow AttributeBoolean event None Indicates the salinity measure is below the salinityTooLowThreshold.
salinityTooHighThreshold AttributeFloat configuration PartsPerThousand Threshold above which a salinityTooHigh event is triggered.
salinityTooLowThreshold AttributeFloat configuration PartsPerThousand Threshold below which a salinityTooLow event is triggered.
NO3TooHigh AttributeBoolean event None Indicates the NO3 measure is above the NO3TooHighThreshold.
NO3TooHighThreshold AttributeFloat configuration MilligramsPerLiter Threshold above which a NO3TooHigh event is triggered. (mg/l)
NH3TooHigh AttributeBoolean event None Indicates the NH3 measure is above the NH3TooHighThreshold.
NH3TooHighThreshold AttributeFloat configuration MilligramsPerLiter Threshold above which a NO3TooHigh event is triggered. (mg/l)
NH4TooHigh AttributeBoolean event None Indicates the NH4 measure is above the NH4TooHighThreshold.
NH4TooHighThreshold AttributeFloat configuration MilligramsPerLiter Threshold above which a NH4TooHigh event is triggered. (mg/l)
applicationType AttributeString configuration None Application Type of the water quality sensor depending on the use case. E.g.: ‘River water quality sensor’

3.41 Text Display Actuator

The Text Display Actuator is used to send text to a text-only or text mode graphics display within a PositionedTextState (text, xPos, yPos). Writing a string of text to the text resource causes it to be displayed at the selected X and Y locations on the display. If X or Y are set to a value greater than the size of the display, the position “wraps around” to the modulus of the setting and the display size. Likewise, if the text string overflows the display size, the text “wraps around” and displays on the next line down or, if the last line has been written, wraps around to the top of the display. Brightness and Contrast controls are provided to allow control of various display types including STN and DSTN type LCD character displays. Setting the clearDisplay to true causes the display to be erased.

See the optionality and profiles information for the Text Display Actuator function

Text Display Actuator function’s attributes
ID Type Scope Unit Description
defaultState AttributePositionedTextState configuration None Sets the default state output for the text display actuator. This shall be applicable if the actuator is not under any scheduled (calendarID) or override control (OverrideCommand).
actualState AttributePositionedTextState measurement None This attribute should reflect the physical state of the source as much as possible. It may be calculated or measured, depending on the specific ODN implementation, which is outside the scope of this specification.
targetCommand AttributeCommand operational None Latest command for the text display actuator.
feedbackCommand AttributeCommand measurement None This attribute reflects the command in effect and it might deviate from the actualState due to propagation time, due to scheduler specific or due to internal ODN specific mechanisms to handle the priority of the requests or response time.
stateChange AttributeBoolean event None This attribute reflects that the state has changed
calendarID AttributeString operational None TALQ Address of the calendar controlling this text display actuator. If this attribute is empty, the behavior shall be determined by the ODN. If the attribute is invalid, the ODN shall trigger a generic invalid address event and the behavior shall be determined by the ODN.
invalidCalendar AttributeBoolean event None This attribute reflects that a calendar has been allocated and can not be implemented it.
invalidProgram AttributeBoolean event None This attribute reflects that a control program has been allocated and can not be implemented it
programChange AttributeBoolean event None This attribute reflects that the control program applicable to the actuator has changed.
calendarChange AttributeBoolean event None This attribute reflects that the calendar applicable to the actuator has changed.
targetCommandChange AttributeBoolean event None This attribute reflects that the targetCommand has changed.
applicationType AttributeString configuration None Application Type of the text display actuator depending on the use case. E.g.: ‘Traffic Panel’
maxXCoordinate AttributeInteger configuration None The highest X coordinate the display supports before wrapping to the next line
maxYCoordinate AttributeInteger configuration None The highest Y coordinate the display supports before wrapping to the next line
level AttributeInteger operational Percent Used to represent a level control such as audio volume, integer value between 0 and 100 as percentage
contrast AttributeInteger operational Percent Proportional control, integer value between 0 and 100 as percentage
clearDisplay AttributeBoolean operational None Command to clear the display

3.42 Parking Sensor

The parking sensor provides actual and accumulated occupancy duration as well as forbidden parking detection.

See the optionality and profiles information for the Parking Sensor function

Parking Sensor function’s attributes
ID Type Scope Unit Description
occupancy AttributeParkingSlotOccupancyStatus measurement None Status of the parking spot from the point of view of occupancy. Enum:‘closed, vacant, occupied, partially occupied, unknown’
duration AttributeInteger measurement Seconds Number of seconds sinde the parking place is occupied. If not occupied, duration shows the duration of the last occupation.
accumulatedDuration AttributeInteger measurement Seconds Accumulated occupation time since accumulatedSince. In seconds.
accumulatedSince AttributeDateTime configuration None Indicates the date and time at which accumulatedDuration is reset to zero. The Gateway may change this value with the actual one depending on implementation.
forbiddenParkingDetected AttributeBoolean event None Indicates if the vehicle present on the parking place is not authorized. Set to false if the place is free or if the vehicle is authorized.
applicationType AttributeString configuration None Application Type of the parking sensor depending on the use case. E.g.: ‘Street parking’
sensorType AttributeString configuration None Type of sensor (e.g.: IR, PIR, AIR, MR)
occupancyChangeToVacant AttributeBoolean event None Indicates that the occupancy has changed to vancant
occupancyChangeToOccupied AttributeBoolean event None Indicates that the occupancy has changed to occupied
overstayDetected AttributeBoolean event None Indicates if the occupancy duration is over the maxDuration
maxDuration AttributeInteger configuration Seconds Max number of seconds for a parking session.

3.43 Parking Camera Sensor

The Parking Camera Sensor provides information about the parking slots that only computer vision can provide.

See the optionality and profiles information for the Parking Camera Sensor function

Parking Camera Sensor function’s attributes
ID Type Scope Unit Description
totalSlots AttributeInteger measurement None Total number of slots monitored by the device.
slotsData AttributeParkingSlotDataArray measurement None Data of each slot.
freeSlots AttributeInteger measurement None Number of free slots on the monitored area.
freeSlotIDs AttributeStringArray measurement None Ids of the free slots
averageDuration AttributeInteger measurement Seconds Average occupation time per vehicle since accumulatedSince.
accumulatedParkingSessions AttributeInteger measurement None Number of parking sessions since accumulatedSince
accumulatedSince AttributeDateTime configuration None Indicates the date and time at which accumulatedParkingSessions and averageDuration are reset to zero. The Gateway may change this value with the actual one depending on implementation.
forbiddenVehicleDetected AttributeBoolean event None Indicates if there is a vehicle present on the parking slots which is not authorized. Set to false if all the places are free or all the vehicles are authorized.
blockingVehicleDetected AttributeBoolean event None Indicates if a vehicle is blocking other
badParkingDetected AttributeBoolean event None Indicates if a vehicle is badly parked (i.e: ocuppying two slots).
applicationType AttributeString configuration None Application Type of the parking camera sensor depending on the use case. E.g.: ‘Parking Camera’
zoneReference AttributeString configuration None Reference of the zone monitored depending on the use case. E.g.: “Zone A1”

3.44 Luminaire Asset

This entity contains the managed and tracked attributes of a specific Luminaire, excluding the concept of Controller and Driver.

See the optionality and profiles information for the Luminaire Asset function

Luminaire Asset function’s attributes
ID Type Scope Unit Description
luminaireTypeAddress AttributeString configuration None Address of the Luminaire Type
bracketTypeAddress AttributeString configuration None Address of the Bracket Type
serial AttributeString configuration None Serial number of the Luminaire
projectID AttributeString configuration None Name of the Project / Tender
luminousFluxConfiguration AttributeInteger configuration Lumens Programmed light output of the luminaire
paintingColor AttributeString configuration None Painting color of the luminaire expressed as a color system-color value, (e.g: RAL-7035)
virtualPowerOutput AttributeLevelState configuration None Percentage of nominal power at which the light source should be set when the Command is set to 100%.
installationTimestamp AttributeDateTime configuration None Installation date and time of luminaire
identification AttributeString configuration None Luminaire identification. (e.g: as per DiiA/D4i specification part 251 (MB1 extension)).
identificationNumber AttributeString configuration None Luminaire identification number. (e.g: as per DiiA/D4i specification part 251 (MB1 extension))
mountingOption AttributeMountingOption configuration None Installed direction of the luminaire to the support
warrantyExpirationDate AttributeDateTime configuration None Warranty expiration date. It can be reset
manufactureYear AttributeInteger configuration None Year of manufacture of the luminaire.
manufactureWeek AttributeInteger configuration None Week of manufacture of the luminaire.
warrantyYears AttributeInteger configuration Years Number of years for warranty
applicationType AttributeString configuration None Application Type of the luminaire asset depending on the use case.

3.45 Driver Asset

This entity contains the managed and tracked attributes of a specific driver

See the optionality and profiles information for the Driver Asset function

Driver Asset function’s attributes
ID Type Scope Unit Description
driverTypeAddress AttributeString configuration None Address of the Driver Type
serial AttributeString configuration None Serial number of the driver
projectID AttributeString configuration None Name of the Project / Tender
firmwareVersion AttributeString configuration None Version of the driver hardware firmware
installationTimestamp AttributeDateTime configuration None Installation date and time of driver
manufactureYear AttributeInteger configuration None Year of manufacture of the driver
manufactureWeek AttributeInteger configuration None Week of manufacture of the driver.
warrantyExpirationDate AttributeDateTime configuration None Warranty expiration date. It can be reset
applicationType AttributeString configuration None Application Type of the driver asset depending on the use case.

3.46 Controller Asset

This entity contains the managed and tracked attributes of a specific controller

See the optionality and profiles information for the Controller Asset function

Controller Asset function’s attributes
ID Type Scope Unit Description
controllerTypeAddress AttributeString configuration None Address of the Controller Type
serial AttributeString configuration None Serial number of the Controller
firmwareVersion AttributeString configuration None Version of the controller hardware firmware
installationTimestamp AttributeDateTime configuration None Installation date and time of OLC
registrationTimestamp AttributeDateTime configuration None Registration date and time of OLC
projectID AttributeString configuration None Name of the Project / Tender
controllerColor AttributeString configuration None Painting color of the controller expressed as a color system-color value, (e.g: RAL-7035)
connectionType AttributeLuminaireConnectionType configuration None Type of the connection to the luminaire
warrantyExpirationDate AttributeDateTime configuration None Warranty expiration date. It can be reset
manufactureYear AttributeInteger configuration None Year of manufacture of the controller
manufactureWeek AttributeInteger configuration None Week of manufacture of the controller
applicationType AttributeString configuration None Application Type of the controller asset depending on the use case.

3.47 Cabinet Configuration

The Cabinet Configuration function defines attributes and functionality needed to control light from a street light cabinet regarding the segment monitors

See the optionality and profiles information for the Cabinet Configuration function

Cabinet Configuration function’s attributes
ID Type Scope Unit Description
applicationType AttributeString configuration None Application Type of the cabinet actuator depending on the use case. E.g.: “Cabinet configuration”
actuatingType AttributeCabinetActuatingType configuration None Actuating Type of the cabinet actuator depending on the use case. E.g.: “DALI, Relay Control”
segmentsConfiguration AttributeCabinetSegmentsConfiguration configuration None This configures how the relays of the segments are to be set for certain light levels, the segment id must match a SegmentMonitor function id.

3.48 Cabinet Monitor

The Cabinet Monitor function defines attributes for monitoring a street light cabinet

See the optionality and profiles information for the Cabinet Monitor function

Cabinet Monitor function’s attributes
ID Type Scope Unit Description
applicationType AttributeString configuration None Application Type of the caibinet actuator depending on the use case. E.g.: “Road Lighting, Architecture Lighting”
cabinetDoorOpen AttributeBoolean event None Indicates that the cabinet door is open.
leakageDetected AttributeBoolean event None Indicates that an earth leakage fault has been detected.

4 Optionality and profiles

TALQ covers a variety of smart city uses cases, including street lighting. Some TALQ implementations may implement all possible TALQ functionality, but many will focus on a subset of applications.

Some TALQ functionality is mandatory across all applications. Some functionality is mandatory for certain applications but optional for others. Some functionality is simply optional across all applications.

To address this range of requirements, the use of Profiles in TALQ has been introduced. The current indication of mandatory or optional for TALQ features is defined for Cabinet Control, Environmental Monitoring, Lighting, Lighting Asset Management, Smart Parking, Smart Traffic and Waste Management profiles, and further profiles are being defined for other applications. A matrix defines which features are mandatory within each profile, all other features are optional. Some features are described as optional but recommended to reflect the level of feature implementation generally expected in each application area, thus assisting interoperability.

Profiles
Cabinet Control Environmental Monitoring Lighting Lighting Asset Management Smart Parking Smart Traffic Waste Management
Functions & Attributes CMS GW CMS GW CMS GW CMS GW CMS GW CMS GW CMS GW
 Basic M M M M M O M M M M M M M M
   displayName O O O O O O O O O O O O O O
   assetId M O M O M O M O M O M O M O
   serial M O M O M O M O M O M O M O
   hwType M O M O M O M O M O M O M O
   hwVersion O O O O O O O O O O O O O O
   swType O O O O O O O O O O O O O O
   swVersion M M M M M M M M M M M M M M
   installationDate O O O O O O O O O O O O O O
   location M O M O M O M O M O M O M O
   deviceReset M M M M M M M M M M M M M M
   softwareUpdating O O O O O O O O O O O O O O
   hardwareUpdating O O O O O O O O O O O O O O
   hardwareUpdated O O O O O O O O O O O O O O
   batteryMode M O O O M O O O O O O O O O
   installationMode M O M O M O M O M O M O M O
   maintenanceMode M O M O M O M O M O M O M O
   cabinetDoorOpen M O O O M O O O O O O O O O
   batteryShutdown M O M O M O M O M O M O M O
   locationUpdated M O M O M O M O M O M O M O
   timeZone M O M O M O M O M O M O M O
   ntpServers O O O O O O O O O O O O O O
   ntpSynchPeriod O O O O O O O O O O O O O O
   currentTime M M M O M M M O M O M O M O
   commandConfirmation O O O O O O O O O O O O O O
   reboot O O O O O O O O O O O O O O
   factoryReset O O O O O O O O O O O O O O
   configurationReset O O O O O O O O O O O O O O
   operatingHours O O O O O O O O O O O O O O
 Gateway M M M M M M M M M M M M M M
   cmsUri M M M M M M M M M M M M M M
   cmsAddress M M M M M M M M M M M M M M
   gatewayUri M M M M M M M M M M M M M M
   gatewayAddress M M M M M M M M M M M M M M
   retryPeriod O M O M O M O M O M O M O M
   gatewayRetryPeriod O O O O O O O M O O O O O O
   cmsRetryPeriod O O O O O O M O O O O O O O
   gatewayNumberOfRetries O O O O O O O M O O O O O O
   cmsNumberOfRetries O O O O O O M O O O O O O O
   crlUrn M M M M M M M M M M M M M M
   vendor M M M M M M M M M M M M M M
   pkgUrl O O O O O O O O O O O O O O
   currentReleaseId O O O O O O O O O O O O O O
   newCmsAttached O O O O O O O O O O O O O O
 Communication M O M O M O M O M O M O M O
   communicationType O O O O O O O O O O O O O O
   logicalAddress O O O O O O O O O O O O O O
   altLogicalAddress O O O O O O O O O O O O O O
   physicalAddress M M M M M M M M M M M M M M
   parentAddress M O M O M O M O M O M O M O
   timeToLive O O O O O O O O O O O O O O
   repeatingEnabled O O O O O O O O O O O O O O
   transmitPower O O O O O O O O O O O O O O
   numberOfHops O O O O O O O O O O O O O O
   communicationQuality O O O O O O O O O O O O O O
   communicationFailure M M M M M M M M M M M M M M
   applicationType O O O O O O O O O O O O O O
 Time O O O O O O O O O O O O O O
   timeZone M O M O M O M O M O M O M O
   ntpServers O O O O O O O O O O O O O O
   ntpSynchPeriod O O O O O O O O O O O O O O
   currentTime M M M O M M M O M O M O M O
   lastTimeSync O O O O O O O O O O O O O O
   lastSyncError O O O O O O O O O O O O O O
 Simple Actuator O O O O O O O O O O O O O O
   defaultState M M M M M M M M M M M M M M
   actualState M M M M M M M M M M M M M M
   targetCommand M M M M M M M M M M M M M M
   feedbackCommand M M M M M M M M M M M M M M
   stateChange M O M O M O M O M O M O M O
   targetCommandChange M O M O M O M O M O M O M O
   applicationType O O O O O O O O O O O O O O
 Generic Actuator O O O O O O O O O O O O O O
   defaultState M M M M M M M M M M M M M M
   actualState M M M M M M M M M M M M M M
   targetCommand M M M M M M M M M M M M M M
   feedbackCommand M M M M M M M M M M M M M M
   stateChange M O M O M O M O M O M O M O
   calendarID M M O O M M O O O O O O O O
   invalidCalendar M O O O M O O O O O O O O O
   invalidProgram M O O O M O O O O O O O O O
   programChange M O O O M O O O O O O O O O
   calendarChange M O O O M O O O O O O O O O
   targetCommandChange M O M O M O M O M O M O M O
   applicationType O O O O O O O O O O O O O O
 Lamp Actuator M O O O M O O O O O O O O O
   lampTypeId O O O O O O O O O O O O O O
   outputPort O O O O O O O O O O O O O O
   standbyMode O O O O O O O O O O O O O O
   cloEnabled O O O O O O O O O O O O O O
   defaultLightState M M M M M M M M M M M M M M
   targetLightCommand M M M M M M M M M M M M M M
   feedbackLightCommand M M M M M M M M M M M M M M
   actualLightState M M M M M M M M M M M M M M
   maintenanceFactorEnabled O O O O O O O O O O O O O O
   maintenancePeriod O O O O O O O O O O O O O O
   maintenanceFactor O O O O O O O O O O O O O O
   lastMaintenanceDate O O O O O O O O O O O O O O
   calendarID M M M M M M M M M M M M M M
   invalidCalendar M O M O M O M O M O M O M O
   invalidProgram M O M O M O M O M O M O M O
   lightStateChange M M M M M M M M M M M M M M
   targetLightCommandChange O O O O O O O O O O O O O O
   programChange O O O O O O O O O O O O O O
   calendarChange O O O O O O O O O O O O O O
   invalidLampType O O O O O O O O O O O O O O
   applicationType O O O O O O O O O O O O O O
 Lamp Monitor M O O O M O O O O O O O O O
   supplyType O O O O O O O O O O O O O O
   lampTypeId O O O O O O O O O O O O O O
   monitoringReference O O O O O O O O O O O O O O
   actuatorReference O O O O O O O O O O O O O O
   numberOfLamps M O M O M O M O M O M O M O
   switchOnCounter O O O O O O O O O O O O O O
   operatingHours M O M O M O M O M O M O M O
   temperature M O M O M O M O M O M O M O
   supplyVoltage M O M O M O M O M O M O M O
   supplyCurrent M O M O M O M O M O M O M O
   activePower M O M O M O M O M O M O M O
   reactivePower O O O O O O O O O O O O O O
   apparentPower O O O O O O O O O O O O O O
   powerFactor M O M O M O M O M O M O M O
   powerFactorSense M O M O M O M O M O M O M O
   activeEnergy M O M O M O M O M O M O M O
   supplyLossCount O O O O O O O O O O O O O O
   lampPowerTooHigh M O M O M O M O M O M O M O
   lampPowerTooLow M O M O M O M O M O M O M O
   lampVoltageTooHigh M O M O M O M O M O M O M O
   lampVoltageTooLow M O M O M O M O M O M O M O
   lampFailure M M M M M M M M M M M M M M
   dimmingFailure O O O O O O O O O O O O O O
   currentTooHigh M O M O M O M O M O M O M O
   currentTooLow M O M O M O M O M O M O M O
   powerFactorTooLow M O M O M O M O M O M O M O
   highTemperature M O M O M O M O M O M O M O
   relayFailure M O M O M O M O M O M O M O
   absolutLampPowerTooHigh M O M O M O M O M O M O M O
   absolutLampPowerTooLow M O M O M O M O M O M O M O
   absoluteLampPowerTooHigh M O M O M O M O M O M O M O
   absoluteLampPowerTooLow M O M O M O M O M O M O M O
   controlGearCommFailure M O M O M O M O M O M O M O
   cyclingFailure M O M O M O M O M O M O M O
   supplyLoss M O M O M O M O M O M O M O
   contactorError M O M O M O M O M O M O M O
   lampUnexpectedOn M O M O M O M O M O M O M O
   leakageDetected M O M O M O M O M O M O M O
   invalidLampType O O O O O O O O O O O O O O
   supplyVoltageTooHigh O O O O O O O O O O O O O O
   supplyVoltageTooLow O O O O O O O O O O O O O O
   highSupplyVoltageThreshold O O O O O O O O O O O O O O
   lowSupplyVoltageThreshold O O O O O O O O O O O O O O
   applicationType O O O O O O O O O O O O O O
 Electrical Meter M O O O M O O O O O O O O O
   totalPowerHighThreshold O O O O O O O O O O O O O O
   totalPowerLowThreshold O O O O O O O O O O O O O O
   powerfactorThreshold O O O O O O O O O O O O O O
   phase1PowerfactorLowThreshold O O O O O O O O O O O O O O
   phase2PowerfactorLowThreshold O O O O O O O O O O O O O O
   phase3PowerfactorLowThreshold O O O O O O O O O O O O O O
   supplyVoltageHighThreshold O O O O O O O O O O O O O O
   supplyVoltageLowThreshold O O O O O O O O O O O O O O
   phase1VoltageHighThreshold O O O O O O O O O O O O O O
   phase1VoltageLowThreshold O O O O O O O O O O O O O O
   phase2VoltageHighThreshold O O O O O O O O O O O O O O
   phase2VoltageLowThreshold O O O O O O O O O O O O O O
   phase3VoltageHighThreshold O O O O O O O O O O O O O O
   phase3VoltageLowThreshold O O O O O O O O O O O O O O
   totalCurrentHighThreshold O O O O O O O O O O O O O O
   totalCurrentLowThreshold O O O O O O O O O O O O O O
   neutralCurrentHighThreshold O O O O O O O O O O O O O O
   phase1CurrentHighThreshold O O O O O O O O O O O O O O
   phase1CurrentLowThreshold O O O O O O O O O O O O O O
   phase2CurrentHighThreshold O O O O O O O O O O O O O O
   phase2CurrentLowThreshold O O O O O O O O O O O O O O
   phase3CurrentHighThreshold O O O O O O O O O O O O O O
   phase3CurrentLowThreshold O O O O O O O O O O O O O O
   phase1ActivePowerHighThreshold O O O O O O O O O O O O O O
   phase1ActivePowerLowThreshold O O O O O O O O O O O O O O
   phase2ActivePowerHighThreshold O O O O O O O O O O O O O O
   phase2ActivePowerLowThreshold O O O O O O O O O O O O O O
   phase3ActivePowerHighThreshold O O O O O O O O O O O O O O
   phase3ActivePowerLowThreshold O O O O O O O O O O O O O O
   totalPower M O M O M O M O M O M O M O
   totalVA O O O O O O O O O O O O O O
   totalVAR O O O O O O O O O O O O O O
   maxDemandPower O O O O O O O O O O O O O O
   totalActiveEnergy M O M O M O M O M O M O M O
   totalReactiveEnergy O O O O O O O O O O O O O O
   totalApparentEnergy O O O O O O O O O O O O O O
   frequency O O O O O O O O O O O O O O
   totalPowerFactor M O M O M O M O M O M O M O
   totalPowerFactorSense O O O O O O O O O O O O O O
   phase1PowerFactor O O O O O O O O O O O O O O
   phase1PowerFactorSense O O O O O O O O O O O O O O
   phase2PowerFactor O O O O O O O O O O O O O O
   phase2PowerFactorSense O O O O O O O O O O O O O O
   phase3PowerFactor O O O O O O O O O O O O O O
   phase3PowerFactorSense O O O O O O O O O O O O O O
   supplyVoltage M O M O M O M O M O M O M O
   phase1Voltage O O O O O O O O O O O O O O
   phase2Voltage O O O O O O O O O O O O O O
   phase3Voltage O O O O O O O O O O O O O O
   voltagePhase1Phase2 O O O O O O O O O O O O O O
   voltagePhase2Phase3 O O O O O O O O O O O O O O
   voltagePhase3Phase1 O O O O O O O O O O O O O O
   totalCurrent M O M O M O M O M O M O M O
   averageCurrent M O M O M O M O M O M O M O
   neutralCurrent O O O O O O O O O O O O O O
   phase1Current O O O O O O O O O O O O O O
   phase2Current O O O O O O O O O O O O O O
   phase3Current O O O O O O O O O O O O O O
   phase1ActivePower O O O O O O O O O O O O O O
   phase2ActivePower O O O O O O O O O O O O O O
   phase3ActivePower O O O O O O O O O O O O O O
   phase1ApparentPower O O O O O O O O O O O O O O
   phase2ApparentPower O O O O O O O O O O O O O O
   phase3ApparentPower O O O O O O O O O O O O O O
   phase1ReactivePower O O O O O O O O O O O O O O
   phase2ReactivePower O O O O O O O O O O O O O O
   phase3ReactivePower O O O O O O O O O O O O O O
   phase1ActiveEnergy O O O O O O O O O O O O O O
   phase2ActiveEnergy O O O O O O O O O O O O O O
   phase3ActiveEnergy O O O O O O O O O O O O O O
   worstCurrentTHD O O O O O O O O O O O O O O
   phase1CurrentTHD O O O O O O O O O O O O O O
   phase2CurrentTHD O O O O O O O O O O O O O O
   phase3CurrentTHD O O O O O O O O O O O O O O
   worstVoltageTHD O O O O O O O O O O O O O O
   averageVoltageTHD O O O O O O O O O O O O O O
   phase1VoltageTHD O O O O O O O O O O O O O O
   phase2VoltageTHD O O O O O O O O O O O O O O
   phase3VoltageTHD O O O O O O O O O O O O O O
   phase1_2VoltageTHD O O O O O O O O O O O O O O
   phase2_3VoltageTHD O O O O O O O O O O O O O O
   phase3_1VoltageTHD O O O O O O O O O O O O O O
   supplyLossCount O O O O O O O O O O O O O O
   phase1SupplyLossCount O O O O O O O O O O O O O O
   phase2SupplyLossCount O O O O O O O O O O O O O O
   phase3SupplyLossCount O O O O O O O O O O O O O O
   totalPowerTooHigh O O O O O O O O O O O O O O
   totalPowerTooLow O O O O O O O O O O O O O O
   powerfactorTooLow O O O O O O O O O O O O O O
   phase1PowerfactorTooLow O O O O O O O O O O O O O O
   phase2PowerfactorTooLow O O O O O O O O O O O O O O
   phase3PowerfactorTooLow O O O O O O O O O O O O O O
   supplyVoltageTooHigh O O O O O O O O O O O O O O
   supplyVoltageTooLow O O O O O O O O O O O O O O
   phase1VoltageTooHigh O O O O O O O O O O O O O O
   phase1VoltageTooLow O O O O O O O O O O O O O O
   phase2VoltageTooHigh O O O O O O O O O O O O O O
   phase2VoltageTooLow O O O O O O O O O O O O O O
   phase3VoltageTooHigh O O O O O O O O O O O O O O
   phase3VoltageTooLow O O O O O O O O O O O O O O
   totalCurrentTooHigh O O O O O O O O O O O O O O
   totalCurrentTooLow O O O O O O O O O O O O O O
   neutralCurrentTooHigh O O O O O O O O O O O O O O
   phase1CurrentTooHigh O O O O O O O O O O O O O O
   phase1CurrentTooLow O O O O O O O O O O O O O O
   phase2CurrentTooHigh O O O O O O O O O O O O O O
   phase2CurrentTooLow O O O O O O O O O O O O O O
   phase3CurrentTooHigh O O O O O O O O O O O O O O
   phase3CurrentTooLow O O O O O O O O O O O O O O
   phase1ActivePowerTooHigh O O O O O O O O O O O O O O
   phase1ActivePowerTooLow O O O O O O O O O O O O O O
   phase2ActivePowerTooHigh O O O O O O O O O O O O O O
   phase2ActivePowerTooLow O O O O O O O O O O O O O O
   phase3ActivePowerTooHigh O O O O O O O O O O O O O O
   phase3ActivePowerTooLow O O O O O O O O O O O O O O
   applicationType O O O O O O O O O O O O O O
   actuatorReference O O O O O O O O O O O O O O
   supplyLoss O O M O O O M O M O M O M O
 Photocell M O O O M O O O O O O O O O
   onLevel M O M O M O M O M O M O M O
   offLevel M O M O M O M O M O M O M O
   photocellOutput M M M M M M M M M M M M M M
   photocellOutputOn M O M O M O M O M O M O M O
   applicationType O O O O O O O O O O O O O O
 Light Sensor O O O O O O O O O O O O O O
   levelHighThreshold M O M O M O M O M O M O M O
   levelLowThreshold M O M O M O M O M O M O M O
   lightLevel M M M M M M M M M M M M M M
   levelTooHigh M O M O M O M O M O M O M O
   levelTooLow M O M O M O M O M O M O M O
   applicationType O O O O O O O O O O O O O O
 Binary Sensor O O O O O O O O O O O O O O
   level M M M M M M M M M M M M M M
   sensorOutputOn M O M O M O M O M O M O M O
   applicationType O O O O O O O O O O O O O O
 Generic Sensor O O O O O O O O O O O O O O
   levelHighThreshold M O M O M O M O M O M O M O
   levelLowThreshold M O M O M O M O M O M O M O
   level M M M M M M M M M M M M M M
   levelTooHigh M O M O M O M O M O M O M O
   levelTooLow M O M O M O M O M O M O M O
   applicationType O O O O O O O O O O O O O O
 Temperature Sensor O O M O O O M O M O M O M O
   temperatureHighThreshold M O M O M O M O M O M O M O
   temperatureLowThreshold M O M O M O M O M O M O M O
   fireDetectionThreshold M O M O M O M O M O M O M O
   temperature M M M M M M M M M M M M M M
   temperatureTooHigh M O M O M O M O M O M O M O
   temperatureTooLow M O M O M O M O M O M O M O
   fireDetected M O M O M O M O M O M O M O
   applicationType O O O O O O O O O O O O O O
   minMeasuredTemperature O O O O O O O O O O O O O O
   maxMeasuredTemperature O O O O O O O O O O O O O O
   measuredTemperatureSince O O O O O O O O O O O O O O
 Humidity Sensor O O M O O O O O O O O O O O
   humidityLowThreshold M O M O M O M O M O M O M O
   humidityHighThreshold M O M O M O M O M O M O M O
   humidity M M M M M M M M M M M M M M
   humidityTooLow M O M O M O M O M O M O M O
   humidityTooHigh M O M O M O M O M O M O M O
   applicationType O O O O O O O O O O O O O O
 Particulate Matter Sensor O O M M O O O O O O O O O O
   pm1HighThreshold M O M O M O M O M O M O M O
   pm2-5HighThreshold M O M O M O M O M O M O M O
   pm10HighThreshold M O M O M O M O M O M O M O
   pm1 M O M M M O M O M O M O M O
   pm2-5 M O M M M O M O M O M O M O
   pm10 M O M M M O M O M O M O M O
   pm1TooHigh M O M O M O M O M O M O M O
   pm2-5TooHigh M O M O M O M O M O M O M O
   pm10TooHigh M O M O M O M O M O M O M O
   applicationType M O M O M O M O M O M O M O
   pm1-24hAverage M O M O M O M O M O M O M O
   pm2-5-24hAverage M O M O M O M O M O M O M O
   pm10-24hAverage M O M O M O M O M O M O M O
 Presence Sensor O O O O O O O O O O O O O O
   presenceStatus M M M M M M M M M M M M M M
   presenceStatusChanged M O M O M O M O M O M O M O
   applicationType O O O O O O O O O O O O O O
 Movement Sensor O O O O O O O O O O O O O O
   movementThreshold M O M O M O M O M O M O M O
   movementDetected M M M M M M M M M M M M M M
   notInProperPosition M O M O M O M O M O M O M O
 Location Sensor O O O O O O O O O O O O M O
   expectedLocation M O M O M O M O M O M O M O
   locationChangedThreshold M O M O M O M O M O M O M O
   location M O M O M O M O M O M O M O
   locationChanged M M M M M M M M M M M M M M
   uncertainty O O O O O O O O O O O O O O
   compassDirection O O O O O O O O O O O O O O
   velocity O O O O O O O O O O O O O O
   speed O O O O O O O O O O O O O O
   applicationType O O O O O O O O O O O O O O
 Accelerometer O O O O O O O O O O O O M O
   impactDetectedAccelerationThreshold M O M O M O M O M O M O M O
   accelerationSamplingPeriod M M M M M M M M M M M M M M
   accelerationX M O M O M O M O M O M O M O
   accelerationY M O M O M O M O M O M O M O
   accelerationZ M O M O M O M O M O M O M O
   acceleration M M M M M M M M M M M M M M
   impactDetected M O M O M O M O M O M O M O
   applicationType O O O O O O O O O O O O O O
 Orientation O O O O O O O O O O O O M O
   expectedOrientation M O M O M O M O M O M O M O
   orientationChangedThreshold M O M O M O M O M O M O M O
   orientation M O M O M O M O M O M O M O
   orientationChanged M M M M M M M M M M M M M M
   applicationType O O O O O O O O O O O O O O
 Battery Level Sensor O O O O O O O O O O O O M O
   powerSource M O M O M O M O M O M O M O
   batteryLevelLowThreshold M O M O M O M O M O M O M O
   batteryLevel M M M M M M M M M M M M M M
   batteryLevelTooLow M O M O M O M O M O M O M O
   applicationType O O O O O O O O O O O O O O
 Filling Level Sensor O O O O O O O O O O O O M M
   levelHighThreshold M O M O M O M O M O M O M O
   containerHeight M O M O M O M O M O M O M O
   containerVolume M O M O M O M O M O M O M O
   fillingHeight M O M O M O M O M O M O M O
   fillingPercentage M O M O M O M O M O M O M O
   containerFull M O M O M O M O M O M O M O
   contentsType M O M O M O M O M O M O M O
   contentsOtherType M O M O M O M O M O M O M O
   applicationType O O O O O O O O O O O O O O
 Solar Battery Charger O O O O O O O O O O O O O O
   inputVoltage M M M M M M M M M M M M M M
   inputCurrent M M M M M M M M M M M M M M
   outputVoltage M M M M M M M M M M M M M M
   outputCurrent M M M M M M M M M M M M M M
   chargerTemperature M O M O M O M O M O M O M O
   PVTemperature M O M O M O M O M O M O M O
   accumulatedEnergy M O M O M O M O M O M O M O
   startChargeInputVoltage M O M O M O M O M O M O M O
   endChargeInputVoltage M O M O M O M O M O M O M O
   highTemperatureThreshold M O M O M O M O M O M O M O
   lowTemperatureThreshold M O M O M O M O M O M O M O
   highPowerThreshold M O M O M O M O M O M O M O
   accumulatedSince M O M O M O M O M O M O M O
   highTemperature M O M O M O M O M O M O M O
   lowTemperature M O M O M O M O M O M O M O
   highPower M O M O M O M O M O M O M O
   charging M O M O M O M O M O M O M O
   applicationType O O O O O O O O O O O O O O
 Battery Management System O O O O O O O O O O O O O O
   batteryChemistry M O M O M O M O M O M O M O
   nominalVoltage M O M O M O M O M O M O M O
   nominalCapacity M O M O M O M O M O M O M O
   batteryVoltage M M M M M M M M M M M M M M
   batteryCurrent M O M O M O M O M O M O M O
   batteryLevel M M M M M M M M M M M M M M
   estimatedCapacity M O M O M O M O M O M O M O
   temperature M M M M M M M M M M M M M M
   batteryEOCVoltageTemperatureMap M O M O M O M O M O M O M O
   batteryEODVoltageTemperatureMap M O M O M O M O M O M O M O
   batteryFullThreshold M O M O M O M O M O M O M O
   batteryEmptyThreshold M O M O M O M O M O M O M O
   overCurrentChargeThreshold M O M O M O M O M O M O M O
   overCurrentDischargeThreshold M O M O M O M O M O M O M O
   highTemperatureThreshold M O M O M O M O M O M O M O
   batteryFull M O M O M O M O M O M O M O
   batteryEmpty M O M O M O M O M O M O M O
   overCurrentCharge M O M O M O M O M O M O M O
   overCurrentDischarge M O M O M O M O M O M O M O
   highTemperature M O M O M O M O M O M O M O
   applicationType O O O O O O O O O O O O O O
 Traffic Counter O O O O O O O O O O M M O O
   roadUserNumber M O M O M O M O M O M O M O
   accumulatedRoadUserNumber M M M M M M M M M M M M M M
   roadUser M M M M M M M M M M M M M M
   accumulatedSince M M M M M M M M M M M M M M
   heavyTrafficDetected M O M O M O M O M O M O M O
   heavyTrafficDetectedThreshold M O M O M O M O M O M O M O
   trafficSamplingPeriod M O M O M O M O M O M O M O
   averageSpeed O O M O O O M O M O M O O O
   averageDistance O O M O O O M O M O M O O O
   speedLimitThreshold O O M O O O M O M O M O O O
   percentageAboveSpeedLimit O O M O O O M O M O M O O O
   applicationType O O M O O O M M M O M M O O
   actualUserNumber O O M O O O M M M O M M O O
   sensorType O O M O O O M O M O M O O O
   dailyRoadUserNumber O O M O O O M M M O M M O O
   minSpeed O O M O O O M O M O M O O O
   maxSpeed O O M O O O M O M O M O O O
   sensorSensitivity O O M O O O M O M O M O O O
   trafficDirection O O M O O O M O M O M O O O
 Fluid Level Sensor O O O O O O O O O O O O O O
   fluidLevelTooHighThreshold M O M O M O M O M O M O M O
   fluidLevelTooLowThreshold M O M O M O M O M O M O M O
   distanceSensorBottom M O M O M O M O M O M O M O
   fluidLevel M M M M M M M M M M M M M M
   fluidLevelTooHigh M O M O M O M O M O M O M O
   fluidLevelTooLow M O M O M O M O M O M O M O
   applicationType O O O O O O O O O O O O O O
 Waste Container O O O O O O O O O O O O M M
   lastCollectionDate M O M O M O M O M O M O M O
   collectionLateThreshold M O M O M O M O M O M O M O
   collectionLate M O M O M O M O M O M O M O
   containerTampered M O M O M O M O M O M O M O
   contentsTampered M O M O M O M O M O M O M O
   wasteType M O M M M O M M M M M M M M
   wasteOtherType M O M M M O M M M M M M M M
   applicationType O O O O O O O O O O O O O O
 pH Sensor O O O O O O O O O O O O O O
   pH M O M M M O M M M M M M M M
   pHHighLevelThreshold M O M O M O M O M O M O M O
   pHLowLevelThreshold M O M O M O M O M O M O M O
   pHTooHigh M O M O M O M O M O M O M O
   pHTooLow M O M O M O M O M O M O M O
   applicationType O O O O O O O O O O O O O O
 Weight Sensor O O O O O O O O O O O O M M
   weightLowThreshold M O M O M O M O M O M O M O
   weightHighThreshold M O M O M O M O M O M O M O
   weight M O M M M O M M M M M M M M
   weightTooLow M O M O M O M O M O M O M O
   weightTooHigh M O M O M O M O M O M O M O
   applicationType O O O O O O O O O O O O O O
 Gas Sensor O O M M O O O O O O O O O O
   gasConcentration M O M M M O M O M O M O M M
   gasHighConcentrationThreshold M O M O M O M O M O M O M O
   gasConcentrationTooHigh M O M O M O M O M O M O M O
   gasName M O M M M O M O M O M O M O
   gasOtherName M O M M M O M O M O M O M O
   applicationType M O M O M O M O M O M O M O
   gasConcentration1hAverage M O M O M O M O M O M O M O
   gasConcentration8hAverage M O M O M O M O M O M O M O
 Segment Monitor O O O O O O O O O O O O O O
   applicationType M O M O M O M O M O M O M O
   segmentReference M O M O M O M O M O M O M O
   actuatorReference O O O O O O O O O O O O O O
   numberOfLoads M O M O M O M O M O M O M O
   switchingErrorOn M O M O M O M O M O M O M O
   switchingErrorOff M O M O M O M O M O M O M O
   leakageDetected M O M O M O M O M O M O M O
   cabinetDoorOpen M O O O M O O O O O O O O O
   circuitBreakerTripped M O O O M O O O O O O O O O
   localOverride M O O O M O O O O O O O O O
   actualState M M M M M M M M M M M M M M
 Noise Monitoring Sensor O O M M O O O O O O O O
   noiseHighThreshold M O M O M O M O M O M O
   noise M M M M M M M M M M M M
   noiseTooHigh M O M O M O M O M O M O
   applicationType M O M O M O M O M O M O
   minMeasuredNoise M O M O M O M O M O M O
   maxMeasuredNoise M O M O M O M O M O M O
   measuredNoiseSince M O M O M O M O M O M O
   abnormalNoiseDetected M O M O M O M O M O M O
   typeOfNoise M O M O M O M O M O M O
 Atmospheric Sensor O O M M O O O O O O O O
   airTemperature M M M M M M M M M M M M
   feelsLikeTemperature M O M O M O M O M O M O
   relativeHumidity M O M M M O M M M M M O
   dewPoint M O M O M O M O M O M O
   atmosphericPressure M O M O M O M O M O M O
   applicationType M O M O M O M O M O M O
 Wind Sensor O O M M O O O O O O O O
   windSpeed O O M M O O M M M M M M O O
   windDirectionString O O M O O O M M M O O O
   windDirection O O M M O O M M M M M M O O
   windGust O O M O O O M M M O O O
   windGustDirection O O M O O O M M M O O O
   maxWindGust O O M O O O M M M O O O
   maxWindGustSince O O M O O O M M M O O O
   applicationType M O M O M O M M M O M O
 Precipitation Sensor O O M M O O O O O O O O O O
   precipitationRate O O M M O O M M M M M M O O
   accumulatedPrecipitation O O M O O O M O M O M O O O
   accumulatedPrecipitationSince O O M O O O M O M O M O O O
   applicationType M O M O M O M O M O M O M O
 Sky Sensor O O M M O O O O O O O O O O
   cloudiness O O M O O O M O M O M O O O
   solarDirectRadiation O O M O O O M O M O M O O O
   visibility O O M O O O M O M O M O O O
   applicationType M O M O M O M O M O M O M O
 Gully Sensor O O M M O O O O O O O O O O
   overfull M M M M M M M M M M M M M M
   levelWarning M O M O M O M O M O M O M O
   grillOpened M O M O M O M O M O M O M O
   siltLevel M O M O M O M O M O M O M O
   applicationType M O M O M O M O M O M O M O
 Water Flow Sensor O O M M O O O O O O O O O O
   flowRate M M M M M M M M M M M M M M
   flowRateTooHighThreshold M O M O M O M O M O M O M O
   flowRateTooLowThreshold M O M O M O M O M O M O M O
   flowRateTooHigh M O M O M O M O M O M O M O
   flowRateTooLow M O M O M O M O M O M O M O
   maxFlowRate M O M O M O M O M O M O M O
   minFlowRate M O M O M O M O M O M O M O
   flowRateSince M O M O M O M O M O M O M O
   applicationType M O M O M O M O M O M O M O
 Water Quality Sensor O O M M O O O O O O O O O O
   pH M O M O M O M O M O M O M O
   chlorine M O M O M O M O M O M O M O
   orp M O M O M O M O M O M O M O
   totalDissolvedGas M O M O M O M O M O M O M O
   dissolvedOxygen M O M O M O M O M O M O M O
   turbidity M O M O M O M O M O M O M O
   conductivity M O M O M O M O M O M O M O
   conductance M O M O M O M O M O M O M O
   totalSuspendedSolids M O M O M O M O M O M O M O
   totalDissolvedSolids M O M O M O M O M O M O M O
   salinity M O M O M O M O M O M O M O
   NO3 M O M O M O M O M O M O M O
   NH3 M O M O M O M O M O M O M O
   NH4 M O M O M O M O M O M O M O
   pHTooHigh M O M O M O M O M O M O M O
   pHTooLow M O M O M O M O M O M O M O
   pHTooHighThreshold M O M O M O M O M O M O M O
   pHTooLowThreshold M O M O M O M O M O M O M O
   chlorineTooHigh M O M O M O M O M O M O M O
   chlorineTooHighThreshold M O M O M O M O M O M O M O
   orpTooLow M O M O M O M O M O M O M O
   orpTooLowThreshold M O M O M O M O M O M O M O
   totalDissolvedGasTooHigh M O M O M O M O M O M O M O
   totalDissolvedGasTooLow M O M O M O M O M O M O M O
   totalDissolvedGasTooHighThreshold M O M O M O M O M O M O M O
   totalDissolvedGasTooLowThreshold M O M O M O M O M O M O M O
   dissolvedOxygenTooLow M O M O M O M O M O M O M O
   dissolvedOxygenTooLowThreshold M O M O M O M O M O M O M O
   turbidityTooHigh M O M O M O M O M O M O M O
   turbidityTooHighThreshold M O M O M O M O M O M O M O
   conductivityTooHigh M O M O M O M O M O M O M O
   conductivityTooHighThreshold M O M O M O M O M O M O M O
   conductanceTooHigh M O M O M O M O M O M O M O
   conductanceTooHighThreshold M O M O M O M O M O M O M O
   totalSuspendedSolidsTooHigh M O M O M O M O M O M O M O
   totalSuspendedSolidsTooHighThreshold M O M O M O M O M O M O M O
   totalDissolvedSolidsTooHigh M O M O M O M O M O M O M O
   totalDissolvedSolidsTooHighThreshold M O M O M O M O M O M O M O
   salinityTooHigh M O M O M O M O M O M O M O
   salinityTooLow M O M O M O M O M O M O M O
   salinityTooHighThreshold M O M O M O M O M O M O M O
   salinityTooLowThreshold M O M O M O M O M O M O M O
   NO3TooHigh M O M O M O M O M O M O M O
   NO3TooHighThreshold M O M O M O M O M O M O M O
   NH3TooHigh M O M O M O M O M O M O M O
   NH3TooHighThreshold M O M O M O M O M O M O M O
   NH4TooHigh M O M O M O M O M O M O M O
   NH4TooHighThreshold M O M O M O M O M O M O M O
   applicationType M O M O M O M O M O M O M O
 Text Display Actuator O O O O O O M M M M O O
   defaultState M M M M M M M M M M M M M M
   actualState M M M M M M M M M M M M M M
   targetCommand M M M M M M M M M M M M M M
   feedbackCommand M M M M M M M M M M M M M M
   stateChange M O M O M O M O M O M O M O
   calendarID O O O O O O O O O O O O
   invalidCalendar O O O O O O O O O O O O
   invalidProgram O O O O O O O O O O O O
   programChange O O O O O O O O O O O O
   calendarChange O O O O O O O O O O O O
   targetCommandChange M O M O M O M O M O M O M O
   applicationType M M M M M M M M M M M M M M
   maxXCoordinate O O O O O O O O O O O O
   maxYCoordinate O O O O O O O O O O O O
   level O O O O O O O O O O O O
   contrast O O O O O O O O O O O O
   clearDisplay O O O O O O O O O O O O
 Parking Sensor O O O O O O O O M M O O O O
   occupancy M M M M M M M M M M M M M M
   duration M O M O M O M O M O M O M O
   accumulatedDuration M O M O M O M O M O M O M O
   accumulatedSince M O M O M O M O M O M O M O
   forbiddenParkingDetected M O M O M O M O M O M O M O
   applicationType M O M O M O M O M O M O M O
   sensorType M O M O M O M O M O M O M O
   occupancyChangeToVacant M O M O M O M O M O M O M O
   occupancyChangeToOccupied M O M O M O M O M O M O M O
   overstayDetected M O M O M O M O M O M O M O
   maxDuration M O M O M O M O M O M O M O
 Parking Camera Sensor O O O O O O O O M O O O O O
   totalSlots M M M M M M M M M M M M M M
   slotsData M O M O M O M O M O M O M O
   freeSlots M O M O M O M O M M M O M O
   freeSlotIDs M O M O M O M O M O M O M O
   averageDuration M O M O M O M O M O M O M O
   accumulatedParkingSessions M O M O M O M O M O M O M O
   accumulatedSince M O M O M O M O M O M O M O
   forbiddenVehicleDetected M O M O M O M O M O M O M O
   blockingVehicleDetected M O M O M O M O M O M O M O
   badParkingDetected M O M O M O M O M O M O M O
   applicationType M O M O M O M O M O M O M O
   zoneReference M O M O M O M O M O M O M O
 Luminaire Asset O O O O O O M M O O O O O O
   luminaireTypeAddress M M M M M M M M M M M M M M
   bracketTypeAddress O O O O O O M M O O O O O O
   serial M M M M M M M M M M M M M M
   projectID M M M M M M M M M M M M M M
   luminousFluxConfiguration M M M M M M M M M M M M M M
   paintingColor O M O M O M M M O M O M O M
   virtualPowerOutput O O O O O O M M O O O O O O
   installationTimestamp M M M M M M M M M M M M M M
   identification M M M M M M M M M M M M M M
   identificationNumber M M M M M M M M M M M M M M
   mountingOption O O O O O O M M O O O O O O
   warrantyExpirationDate O O O O O O M M O O O O O O
   manufactureYear O O O O O O M M O O O O O O
   manufactureWeek O O O O O O M M O O O O O O
   warrantyYears O O O O O O M M O O O O O O
   applicationType M O M O M O M M M O M O M O
 Driver Asset O O O O O O O O O O O O O O
   driverTypeAddress O O O O O O O O O O O O O O
   serial O O O O O O O O O O O O O O
   projectID O O O O O O O O O O O O O O
   firmwareVersion O O O O O O O O O O O O O O
   installationTimestamp O O O O O O O O O O O O O O
   manufactureYear O O O O O O O O O O O O O O
   manufactureWeek O O O O O O O O O O O O O O
   warrantyExpirationDate O O O O O O O O O O O O O O
   applicationType M O M O M O O O M O M O M O
 Controller Asset O O O O O O M M O O O O O O
   controllerTypeAddress M M M M M M M M M M M M M M
   serial M M M M M M M M M M M M M M
   firmwareVersion M M M M M M M M M M M M M M
   installationTimestamp M M M M M M M M M M M M M M
   registrationTimestamp M M M M M M M M M M M M M M
   projectID M M M M M M M M M M M M M M
   controllerColor O O O O O O M M O O O O O O
   connectionType M M M M M M M M M M M M M M
   warrantyExpirationDate O O O O O O M M O O O O O O
   manufactureYear O O O O O O M M O O O O O O
   manufactureWeek O O O O O O M M O O O O O O
   applicationType M O M O M O M M M O M O M O
 Cabinet Configuration M M O O O O O O O O O O O O
   applicationType M O M O M O O O M O M O M O
   actuatingType M M M M M M O O M M M M M M
   segmentsConfiguration M O M O M O O O M O M O M O
 Cabinet Monitor M M O O O O O O O O O O O O
   applicationType M O M O M O O O M O M O M O
   cabinetDoorOpen M O M O M O O O M O M O M O
   leakageDetected M O M O M O O O M O M O M O

M = Mandatory (for a Function) or Mandatory if the function is supported (for an attribute); O = Optional, but recommended;