oma-json

{ "openapi": "3.0.0", "info": { "title": "Mocking OpenAPI Schema", "version": "1.0.0" }, "paths": { "/": { "get": { "operationId": "get_oma_resources", "summary": "Fake opeation", "tags": [ "OMAResources" ], "responses": { "200": { "description": "Fake description", "content": { "application/json": { "schema": { "description": "Fake schema", "type": "string" } } } } } } } }, "servers": [ { "url": "/" } ], "components": { "schemas": { "DigitalInput": { "title": "DigitalInput", "x-alt-title": "3200", "description": "Generic digital input for non-specific sensors", "type": "object", "properties": { "5500": { "title": "5500", "x-alt-title": "digitalInputState", "description": "The current state of a digital input.", "type": "boolean", "default": 1, "nullable": true, "readOnly": true, "writeOnly": false }, "5501": { "title": "5501", "x-alt-title": "digitalInputCounter", "description": "The cumulative value of active state detected.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5502": { "title": "5502", "x-alt-title": "digitalInputPolarity", "description": "The polarity of the digital input as a Boolean (0 = Normal, 1= Reversed).", "type": "boolean", "default": 1, "nullable": true, "readOnly": false, "writeOnly": false }, "5503": { "title": "5503", "x-alt-title": "digitalInputDebounce", "description": "The debounce period in ms.", "type": "number", "default": 0, "nullable": true, "readOnly": false, "writeOnly": false }, "5504": { "title": "5504", "x-alt-title": "digitalInputEdgeSelection", "description": "The edge selection as an integer (1 = Falling edge, 2 = Rising edge, 3 = Both Rising and Falling edge).", "type": "number", "default": 1, "nullable": true, "readOnly": false, "writeOnly": false }, "5505": { "title": "5505", "x-alt-title": "digitalInputCounterReset", "description": "Reset the Counter value.", "type": "string", "default": 1, "nullable": true, "readOnly": false, "writeOnly": false }, "5750": { "title": "5750", "x-alt-title": "applicationType", "description": "The application type of the sensor or actuator as a string, for instance, “Air Pressure”.", "type": "string", "default": "app_name", "nullable": true, "readOnly": false, "writeOnly": false }, "5751": { "title": "5751", "x-alt-title": "sensorType", "description": "The type of the sensor (for instance PIR type).", "type": "string", "default": "sensor_name", "nullable": true, "readOnly": true, "writeOnly": false } }, "required": [], "additionalProperties": false }, "DigitalOutput": { "title": "DigitalOutput", "x-alt-title": "3201", "description": "Generic digital output for non-specific actuators", "type": "object", "properties": { "5550": { "title": "5550", "x-alt-title": "digitalOutputState", "description": "The current state of a digital output, 0=OFF, 1=ON..", "type": "boolean", "default": 1, "nullable": true, "readOnly": false, "writeOnly": false }, "5551": { "title": "5551", "x-alt-title": "digitalOutputPolarity", "description": "The polarity of a digital ouput as a Boolean (0 = Normal, 1= Reversed).", "type": "boolean", "default": 1, "nullable": true, "readOnly": false, "writeOnly": false }, "5750": { "title": "5750", "x-alt-title": "applicationType", "description": "The application type of the sensor or actuator as a string, for instance, “Air Pressure”.", "type": "string", "default": "app_name", "nullable": true, "readOnly": false, "writeOnly": false } }, "required": [], "additionalProperties": false }, "AnalogInput": { "title": "AnalogInput", "x-alt-title": "3202", "description": "Generic analog input for non-specific sensors", "type": "object", "properties": { "5600": { "title": "5600", "x-alt-title": "analogInputState", "description": "The current value of the analog input.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5601": { "title": "5601", "x-alt-title": "minMeasuredValue", "description": "The minimum value that can be measured by the sensor", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5602": { "title": "5602", "x-alt-title": "maxMeasuredValue", "description": "The maximum value that can be measured by the sensor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5603": { "title": "5603", "x-alt-title": "minRangeValue", "description": "The minimum value that can be measured by the sensor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5604": { "title": "5604", "x-alt-title": "maxRangeValue", "description": "The maximum value that can be measured by the sensor.", "type": "number", "default": 1024, "nullable": true, "readOnly": true, "writeOnly": false }, "5605": { "title": "5605", "x-alt-title": "resetMinAndMaxMeasuredValues", "description": "Reset the Min and Max Measured Values to Current Value.", "type": "string", "default": "", "nullable": true, "readOnly": false, "writeOnly": false }, "5750": { "title": "5750", "x-alt-title": "applicationType", "description": "The application type of the sensor or actuator as a string, for instance, “Air Pressure”.", "type": "string", "default": "app", "nullable": true, "readOnly": false, "writeOnly": false }, "5751": { "title": "5751", "x-alt-title": "sensorType", "description": "The type of the sensor (for instance PIR type).", "type": "string", "default": "analog_input", "nullable": true, "readOnly": true, "writeOnly": false } }, "required": [], "additionalProperties": false }, "AnalogOutput": { "title": "AnalogOutput", "x-alt-title": "3203", "description": " generic object that can be used with any kind of analog output interface.", "type": "object", "properties": { "5603": { "title": "5603", "x-alt-title": "minRangeValue", "description": "The minimum value that can be measured by the sensor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5604": { "title": "5604", "x-alt-title": "maxRangeValue", "description": "The maximum value that can be measured by the sensor.", "type": "number", "default": 1024, "nullable": true, "readOnly": true, "writeOnly": false }, "5650": { "title": "5650", "x-alt-title": "analogOutputCurrentValue", "description": "The current state of the analogue output.", "type": "number", "default": 0, "nullable": true, "readOnly": false, "writeOnly": false }, "5750": { "title": "5750", "x-alt-title": "applicationType", "description": "The application type of the sensor or actuator as a string, for instance, “Air Pressure”.", "type": "string", "default": "app", "nullable": true, "readOnly": false, "writeOnly": false } }, "required": [], "additionalProperties": false }, "GenericSensor": { "title": "GenericSensor", "x-alt-title": "3300", "description": "It is based on the description of a value and a unit according to the UCUM specification. Thus, any type of value defined within this specification can be reporting using this object. Specific object for a given range of sensors is described later in the document, enabling to identify the type of sensors directly from its Object ID. This object may be used as a generic object if a dedicated one does not exist.", "type": "object", "properties": { "5601": { "title": "5601", "x-alt-title": "minMeasuredValue", "description": "The minimum value that can be measured by the sensor", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5602": { "title": "5602", "x-alt-title": "maxMeasuredValue", "description": "The maximum value that can be measured by the sensor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5603": { "title": "5603", "x-alt-title": "minRangeValue", "description": "The minimum value that can be measured by the sensor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5604": { "title": "5604", "x-alt-title": "maxRangeValue", "description": "The maximum value that can be measured by the sensor.", "type": "number", "default": 10000, "nullable": true, "readOnly": true, "writeOnly": false }, "5605": { "title": "5605", "x-alt-title": "resetMinAndMaxMeasuredValues", "description": "Reset the Min and Max Measured Values to Current Value.", "type": "string", "default": "", "nullable": true, "readOnly": false, "writeOnly": false }, "5700": { "title": "5700", "x-alt-title": "sensorValue", "description": "Last or Current Measured Value from the Sensor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5701": { "title": "5701", "x-alt-title": "sensorUnits", "description": "If present, the type of sensor defined as the UCUM Unit Definition e.g. “Cel” for Temperature in Celcius.", "type": "string", "default": "custom_unit", "nullable": true, "readOnly": true, "writeOnly": false }, "5750": { "title": "5750", "x-alt-title": "applicationType", "description": "The application type of the sensor or actuator as a string, for instance, “Air Pressure”.", "type": "string", "default": "custom_app", "nullable": true, "readOnly": false, "writeOnly": false }, "5751": { "title": "5751", "x-alt-title": "sensorType", "description": "The type of the sensor (for instance PIR type).", "type": "string", "default": "custom_sensor", "nullable": true, "readOnly": true, "writeOnly": false } }, "required": [], "additionalProperties": false }, "IlluminanceSensor": { "title": "IlluminanceSensor", "x-alt-title": "3301", "description": "Illuminance sensor, example units = lx", "type": "object", "properties": { "5601": { "title": "5601", "x-alt-title": "minMeasuredValue", "description": "The minimum value that can be measured by the sensor", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5602": { "title": "5602", "x-alt-title": "maxMeasuredValue", "description": "The maximum value that can be measured by the sensor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5603": { "title": "5603", "x-alt-title": "minRangeValue", "description": "The minimum value that can be measured by the sensor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5604": { "title": "5604", "x-alt-title": "maxRangeValue", "description": "The maximum value that can be measured by the sensor.", "type": "number", "default": 100000, "nullable": true, "readOnly": true, "writeOnly": false }, "5605": { "title": "5605", "x-alt-title": "resetMinAndMaxMeasuredValues", "description": "Reset the Min and Max Measured Values to Current Value.", "type": "string", "default": 0, "nullable": true, "readOnly": false, "writeOnly": false }, "5700": { "title": "5700", "x-alt-title": "sensorValue", "description": "Last or Current Measured Value from the Sensor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5701": { "title": "5701", "x-alt-title": "sensorUnits", "description": "If present, the type of sensor defined as the UCUM Unit Definition e.g. “Cel” for Temperature in Celcius.", "type": "string", "default": "Lux", "nullable": true, "readOnly": true, "writeOnly": false } }, "required": [], "additionalProperties": false }, "PresenceSensor": { "title": "PresenceSensor", "x-alt-title": "3302", "description": "Presence sensor with digital sensing, optional delay parameters", "type": "object", "properties": { "5500": { "title": "5500", "x-alt-title": "digitalInputState", "description": "The current state of a digital input.", "type": "boolean", "default": false, "nullable": true, "readOnly": true, "writeOnly": false }, "5501": { "title": "5501", "x-alt-title": "digitalInputCounter", "description": "The cumulative value of active state detected.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5505": { "title": "5505", "x-alt-title": "digitalInputCounterReset", "description": "Reset the Counter value.", "type": "string", "default": "", "nullable": true, "readOnly": false, "writeOnly": false }, "5751": { "title": "5751", "x-alt-title": "sensorType", "description": "The type of the sensor (for instance PIR type).", "type": "string", "default": "Presence_sensor", "nullable": true, "readOnly": true, "writeOnly": false }, "5903": { "title": "5903", "x-alt-title": "busyToClearDelay", "description": "Delay from the detection state to the clear state in ms.", "type": "number", "default": 0, "nullable": true, "readOnly": false, "writeOnly": false }, "5904": { "title": "5904", "x-alt-title": "clearToBusyDelay", "description": "Delay from the clear state to the busy state in ms.", "type": "number", "default": 0, "nullable": true, "readOnly": false, "writeOnly": false } }, "required": [], "additionalProperties": false }, "TemperatureSensor": { "title": "TemperatureSensor", "x-alt-title": "3303", "description": "used with a temperature sensor to report a temperature measurement. It also provides resources for minimum/maximum measured values and the minimum/maximum range that can be measured by the temperature sensor. An example measurement unit is degrees Celsius", "type": "object", "properties": { "5601": { "title": "5601", "x-alt-title": "minMeasuredValue", "description": "The minimum value that can be measured by the sensor", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5602": { "title": "5602", "x-alt-title": "maxMeasuredValue", "description": "The maximum value that can be measured by the sensor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5603": { "title": "5603", "x-alt-title": "minRangeValue", "description": "The minimum value that can be measured by the sensor.", "type": "number", "default": -20, "nullable": true, "readOnly": true, "writeOnly": false }, "5604": { "title": "5604", "x-alt-title": "maxRangeValue", "description": "The maximum value that can be measured by the sensor.", "type": "number", "default": 80, "nullable": true, "readOnly": true, "writeOnly": false }, "5605": { "title": "5605", "x-alt-title": "resetMinAndMaxMeasuredValues", "description": "Reset the Min and Max Measured Values to Current Value.", "type": "string", "default": "", "nullable": true, "readOnly": false, "writeOnly": false }, "5700": { "title": "5700", "x-alt-title": "sensorValue", "description": "Last or Current Measured Value from the Sensor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5701": { "title": "5701", "x-alt-title": "sensorUnits", "description": "If present, the type of sensor defined as the UCUM Unit Definition e.g. “Cel” for Temperature in Celcius.", "type": "string", "default": "°C", "nullable": true, "readOnly": true, "writeOnly": false } }, "required": [], "additionalProperties": false }, "HumiditySensor": { "title": "HumiditySensor", "x-alt-title": "3304", "description": "used with a humidity sensor to report a humidity measurement. It also provides resources for minimum/maximum measured values and the minimum/maximum range that can be measured by the humidity sensor. An example measurement unit is relative humidity as a percentage ", "type": "object", "properties": { "5601": { "title": "5601", "x-alt-title": "minMeasuredValue", "description": "The minimum value that can be measured by the sensor", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5602": { "title": "5602", "x-alt-title": "maxMeasuredValue", "description": "The maximum value that can be measured by the sensor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5603": { "title": "5603", "x-alt-title": "minRangeValue", "description": "The minimum value that can be measured by the sensor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5604": { "title": "5604", "x-alt-title": "maxRangeValue", "description": "The maximum value that can be measured by the sensor.", "type": "number", "default": 100, "nullable": true, "readOnly": true, "writeOnly": false }, "5605": { "title": "5605", "x-alt-title": "resetMinAndMaxMeasuredValues", "description": "Reset the Min and Max Measured Values to Current Value.", "type": "string", "default": "", "nullable": true, "readOnly": false, "writeOnly": false }, "5700": { "title": "5700", "x-alt-title": "sensorValue", "description": "Last or Current Measured Value from the Sensor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5701": { "title": "5701", "x-alt-title": "sensorUnits", "description": "If present, the type of sensor defined as the UCUM Unit Definition e.g. “Cel” for Temperature in Celcius.", "type": "string", "default": "%", "nullable": true, "readOnly": true, "writeOnly": false } }, "required": [], "additionalProperties": false }, "PowerMeasurment": { "title": "PowerMeasurment", "x-alt-title": "3305", "description": "used over a power measurement sensor to report a remote power measurement. It also provides resources for minimum/maximum measured values and the minimum/maximum range for both active and reactive power. Il also provides resources for cumulative energy, calibration, and the power factor.", "type": "object", "properties": { "5605": { "title": "5605", "x-alt-title": "resetMinAndMaxMeasuredValues", "description": "Reset the Min and Max Measured Values to Current Value.", "type": "string", "default": 0, "nullable": true, "readOnly": false, "writeOnly": false }, "5800": { "title": "5800", "x-alt-title": "instantaneousActivePower", "description": "The current active power.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5801": { "title": "5801", "x-alt-title": "minMeasuredActivePower", "description": "The minimum active power measured by the sensor since it is ON.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5802": { "title": "5802", "x-alt-title": "maxMeasuredActivePower", "description": "The maximum active power measured by the sensor since it is ON.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5803": { "title": "5803", "x-alt-title": "minRangeActivePower", "description": "The minimum active power that can be measured by the sensor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5804": { "title": "5804", "x-alt-title": "maxRangeActivePower", "description": "The maximum active power that can be measured by the sensor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5805": { "title": "5805", "x-alt-title": "cumulativeActivePower", "description": "The total power in Wh that the light has used.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5806": { "title": "5806", "x-alt-title": "activePowerCalibration", "description": "Request an active power calibration by writing the value of a calibrated load.", "type": "number", "default": 0, "nullable": true, "readOnly": false, "writeOnly": true }, "5810": { "title": "5810", "x-alt-title": "instantaneousReactivePower", "description": "The current reactive power.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5811": { "title": "5811", "x-alt-title": "minMeasuredReactivePower", "description": "The minimum reactive power measured by the sensor since it is ON.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5812": { "title": "5812", "x-alt-title": "maxMeasuredReactivePower", "description": "The maximum reactive power measured by the sensor since it is ON.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5813": { "title": "5813", "x-alt-title": "minRangeReactivePower", "description": "The minimum active power that can be measured by the sensor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5814": { "title": "5814", "x-alt-title": "maxRangeReactivePower", "description": "The minimum active power that can be measured by the sensor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5815": { "title": "5815", "x-alt-title": "cumulativeReactivePower", "description": "The cumulative reactive power since the last cumulative energy reset or device start.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5816": { "title": "5816", "x-alt-title": "reactivePowerCalibration", "description": "Request a reactive power calibration by writing the value of a calibrated load.", "type": "number", "default": 0, "nullable": true, "readOnly": false, "writeOnly": true }, "5820": { "title": "5820", "x-alt-title": "powerFactor", "description": "The power factor of the actuactor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5821": { "title": "5821", "x-alt-title": "currentCalibration", "description": "Read or Write the current calibration coefficient.", "type": "number", "default": 0, "nullable": true, "readOnly": false, "writeOnly": false }, "5822": { "title": "5822", "x-alt-title": "resetCumulativeEnergy", "description": "Reset both cumulative active/reactive power.", "type": "string", "default": 0, "nullable": true, "readOnly": false, "writeOnly": false } }, "required": [], "additionalProperties": false }, "Actuation": { "title": "Actuation", "x-alt-title": "3306", "description": "dedicated to remote actuation such as ON/OFF action or dimming. A multi-state output can also be described as a string. This is useful to send pilot wire orders for instance. It also provides a resource to reflect the time that the device has been switched on.", "type": "object", "properties": { "5750": { "title": "5750", "x-alt-title": "applicationType", "description": "The application type of the sensor or actuator as a string, for instance, “Air Pressure”.", "type": "string", "default": "app_name", "nullable": true, "readOnly": false, "writeOnly": false }, "5850": { "title": "5850", "x-alt-title": "onOff", "description": "This resource represents a power source, which can be controlled, the setting of which is a Boolean value (1,0) where 1 is on and 0 is off", "type": "boolean", "default": false, "nullable": true, "readOnly": false, "writeOnly": false }, "5851": { "title": "5851", "x-alt-title": "dimmer", "description": "This resource represents dimmer setting, which has an Integer value between 0 and 100 as a percentage.", "type": "number", "default": 0, "nullable": true, "readOnly": false, "writeOnly": false }, "5852": { "title": "5852", "x-alt-title": "onTime", "description": "The time in seconds that the device has been on. Writing a value of 0 resets the counter.", "type": "number", "default": 0, "nullable": true, "readOnly": false, "writeOnly": false }, "5853": { "title": "5853", "x-alt-title": "multiStateOutput", "description": "A string describing a state for multiple level output such as Pilot Wire.", "type": "string", "default": "", "nullable": true, "readOnly": false, "writeOnly": false } }, "required": [], "additionalProperties": false }, "SetPoint": { "title": "SetPoint", "x-alt-title": "3308", "description": "used to set a desired value to a controller, such as a thermostat. This object enables a setpoint to be expressed units defined in the UCUM specification, to match an associated sensor or measurement value. A special resource is added to set the colour of an object", "type": "object", "properties": { "5701": { "title": "5701", "x-alt-title": "sensorUnits", "description": "If present, the type of sensor defined as the UCUM Unit Definition e.g. “Cel” for Temperature in Celcius.", "type": "string", "default": "unit", "nullable": true, "readOnly": true, "writeOnly": false }, "5706": { "title": "5706", "x-alt-title": "colour", "description": "A string representing a value in some color space", "type": "string", "default": "color", "nullable": true, "readOnly": false, "writeOnly": false }, "5750": { "title": "5750", "x-alt-title": "applicationType", "description": "The application type of the sensor or actuator as a string, for instance, “Air Pressure”.", "type": "string", "default": "app_name", "nullable": true, "readOnly": false, "writeOnly": false }, "5900": { "title": "5900", "x-alt-title": "setPointValue", "description": "The setpoint value.", "type": "number", "default": false, "nullable": true, "readOnly": false, "writeOnly": false } }, "required": [], "additionalProperties": false }, "LoadControl": { "title": "LoadControl", "x-alt-title": "3310", "description": "used for demand-response load control and other load control in automation application (not limited to power)", "type": "object", "properties": { "5750": { "title": "5750", "x-alt-title": "applicationType", "description": "The application type of the sensor or actuator as a string, for instance, “Air Pressure”.", "type": "string", "default": "app_name", "nullable": true, "readOnly": false, "writeOnly": false }, "5823": { "title": "5823", "x-alt-title": "eventIdentifier", "description": "The event identifier as a string.", "type": "string", "default": "event_id", "nullable": true, "readOnly": false, "writeOnly": false }, "5824": { "title": "5824", "x-alt-title": "startTime", "description": "Time when the load control event will start started.", "type": "number", "default": "date_time", "nullable": true, "readOnly": false, "writeOnly": false }, "5825": { "title": "5825", "x-alt-title": "durationInMin", "description": "The duration of the load control event.", "type": "number", "default": "5", "nullable": true, "readOnly": false, "writeOnly": false }, "5826": { "title": "5826", "x-alt-title": "criticalityLevel", "description": "The criticality of the event. The device receiving the event will react in an appropriate fashion for the device.", "type": "number", "default": "warning", "nullable": true, "readOnly": false, "writeOnly": false }, "5827": { "title": "5827", "x-alt-title": "avgLoadAdjPct", "description": "Defines the maximum energy usage of the receivng device, as a percentage of the device's normal maximum energy usage.", "type": "string", "default": "0", "nullable": true, "readOnly": false, "writeOnly": false }, "5828": { "title": "5828", "x-alt-title": "dutyCycle", "description": "Defines the duty cycle for the load control event, i.e, what percentage of time the receiving device is allowed to be on.", "type": "number", "default": "0", "nullable": true, "readOnly": false, "writeOnly": false } }, "required": [], "additionalProperties": false }, "LightControl": { "title": "LightControl", "x-alt-title": "3311", "description": "used to control a light source, such as a LED or other light. It allows a light to be turned on or off and its dimmer setting to be control as a % between 0 and 100. An optional colour setting enables a string to be used to indicate the desired colour.", "type": "object", "properties": { "5701": { "title": "5701", "x-alt-title": "sensorUnits", "description": "If present, the type of sensor defined as the UCUM Unit Definition e.g. “Cel” for Temperature in Celcius.", "type": "string", "default": "unit", "nullable": true, "readOnly": true, "writeOnly": false }, "5706": { "title": "5706", "x-alt-title": "colour", "description": "A string representing a value in some color space", "type": "string", "default": "color", "nullable": true, "readOnly": false, "writeOnly": false }, "5750": { "title": "5750", "x-alt-title": "applicationType", "description": "The application type of the sensor or actuator as a string, for instance, “Air Pressure”.", "type": "string", "default": "app_name", "nullable": true, "readOnly": false, "writeOnly": false }, "5805": { "title": "5805", "x-alt-title": "cumulativeActivePower", "description": "The total power in Wh that the light has used.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5820": { "title": "5820", "x-alt-title": "powerFactor", "description": "The power factor of the actuactor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5850": { "title": "5850", "x-alt-title": "onOff", "description": "This resource represents a power source, which can be controlled, the setting of which is a Boolean value (1,0) where 1 is on and 0 is off", "type": "boolean", "default": false, "nullable": true, "readOnly": false, "writeOnly": false }, "5851": { "title": "5851", "x-alt-title": "dimmer", "description": "This resource represents dimmer setting, which has an Integer value between 0 and 100 as a percentage.", "type": "number", "default": 100, "nullable": true, "readOnly": false, "writeOnly": false }, "5852": { "title": "5852", "x-alt-title": "onTime", "description": "The time in seconds that the device has been on. Writing a value of 0 resets the counter.", "type": "number", "default": 1, "nullable": true, "readOnly": false, "writeOnly": false } }, "required": [], "additionalProperties": false }, "PowerControl": { "title": "PowerControl", "x-alt-title": "3312", "description": "used to control a power source, such as a Smart Plug. It allows a power relay to be turned on or off and its dimmer setting to be control as a % between 0 and 100.", "type": "object", "properties": { "5750": { "title": "5750", "x-alt-title": "applicationType", "description": "The application type of the sensor or actuator as a string, for instance, “Air Pressure”.", "type": "string", "default": "app_name", "nullable": true, "readOnly": false, "writeOnly": false }, "5805": { "title": "5805", "x-alt-title": "cumulativeActivePower", "description": "The total power in Wh that the light has used.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5820": { "title": "5820", "x-alt-title": "powerFactor", "description": "The power factor of the actuactor.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5850": { "title": "5850", "x-alt-title": "onOff", "description": "This resource represents a power source, which can be controlled, the setting of which is a Boolean value (1,0) where 1 is on and 0 is off", "type": "boolean", "default": false, "nullable": true, "readOnly": false, "writeOnly": false }, "5851": { "title": "5851", "x-alt-title": "dimmer", "description": "This resource represents dimmer setting, which has an Integer value between 0 and 100 as a percentage.", "type": "number", "default": 100, "nullable": true, "readOnly": false, "writeOnly": false }, "5852": { "title": "5852", "x-alt-title": "onTime", "description": "The time in seconds that the device has been on. Writing a value of 0 resets the counter.", "type": "number", "default": 1, "nullable": true, "readOnly": false, "writeOnly": false } }, "required": [], "additionalProperties": false }, "Accelerometer": { "title": "Accelerometer", "x-alt-title": "3313", "description": "can be used to represent a 1-3 axis accelerometer.", "type": "object", "properties": { "5603": { "title": "5603", "x-alt-title": "minRangeValue", "description": "The minimum value that can be measured by the sensor.", "type": "number", "default": 10, "nullable": true, "readOnly": true, "writeOnly": false }, "5604": { "title": "5604", "x-alt-title": "maxRangeValue", "description": "The maximum value that can be measured by the sensor.", "type": "number", "default": -10, "nullable": true, "readOnly": true, "writeOnly": false }, "5701": { "title": "5701", "x-alt-title": "sensorUnits", "description": "If present, the type of sensor defined as the UCUM Unit Definition e.g. “Cel” for Temperature in Celcius.", "type": "string", "default": "G", "nullable": true, "readOnly": true, "writeOnly": false }, "5702": { "title": "5702", "x-alt-title": "xValue", "description": "The measured value along the X axis.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5703": { "title": "5703", "x-alt-title": "yValue", "description": "The measured value along the Y axis.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5704": { "title": "5704", "x-alt-title": "zValue", "description": "The measured value along the Z axis.", "type": "number", "default": 1, "nullable": true, "readOnly": true, "writeOnly": false } }, "required": [], "additionalProperties": false }, "Magnetometer": { "title": "Magnetometer", "x-alt-title": "3314", "description": "used to represent a 1-3 axis magnetometer with optional compass direction.", "type": "object", "properties": { "5701": { "title": "5701", "x-alt-title": "sensorUnits", "description": "If present, the type of sensor defined as the UCUM Unit Definition e.g. “Cel” for Temperature in Celcius.", "type": "string", "default": "G", "nullable": true, "readOnly": true, "writeOnly": false }, "5702": { "title": "5702", "x-alt-title": "xValue", "description": "The measured value along the X axis.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5703": { "title": "5703", "x-alt-title": "yValue", "description": "The measured value along the Y axis.", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5704": { "title": "5704", "x-alt-title": "zValue", "description": "The measured value along the Z axis.", "type": "number", "default": 1, "nullable": true, "readOnly": true, "writeOnly": false }, "5705": { "title": "5705", "x-alt-title": "compassDirection", "description": "The compass direction.", "type": "number", "default": 360, "nullable": true, "readOnly": true, "writeOnly": false } }, "required": [], "additionalProperties": false }, "Barometer": { "title": "Barometer", "x-alt-title": "3315", "description": "used with an air pressure sensor to report a barometer measurement. It also provides resources for minimum/maximum measured values and the minimum/maximum range that can be measured by the barometer sensor. An example measurement unit is kPa (ucum:kPa).", "type": "object", "properties": { "5601": { "title": "5601", "x-alt-title": "minMeasuredValue", "description": "The minimum value that can be measured by the sensor", "type": "number", "default": 0, "nullable": true, "readOnly": true, "writeOnly": false }, "5602": { "title": "5602", "x-alt-title": "maxMeasuredValue",