{ "$schema": "http://json-schema.org/schema#", "$schemaVersion": "0.0.1", "modelTags": "OCF", "$id": "https://smart-data-models.github.io/dataModel.OCF/Alarm/schema.json", "title": "Smart Data models - Alarm schema derived from the open connectivity foundation repository https://github.com/openconnectivityfoundation/IoTDataModels", "description": "This Resource describes the Properties associated with alarm status.", "type": "object", "allOf": [ { "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/GSMA-Commons" }, { "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/Location-Commons" }, { "properties": { "rt": { "description": "Property. The Resource Type", "items": { "enum": [ "oic.r.alarm" ], "type": "string" }, "minItems": 1, "uniqueItems": true, "readOnly": true, "type": "array" }, "status": { "description": "Property. This Property describes the status of the alarm: true - on, false - off", "type": "boolean", "readOnly": false }, "duration": { "description": "Property. This Property describes the alarm duration (seconds)", "type": "number", "minimum": 0.0, "readOnly": false }, "time": { "description": "Property. This Property describes the alarm time using ISO 8601 datetime format (e.g: 2007-04-05T14:30Z, 2007-04-05T14:30+09:00)", "type": "string", "readOnly": false }, "alarmtype": { "description": "Property. The Alarm Type", "type": "string", "enum": [ "General", "Fire", "Flood", "Weather", "Security" ], "readOnly": true }, "n": { "type": "string", "maxLength": 64, "readOnly": true, "description": "Property. Friendly name of the Resource" }, "if": { "description": "Property. The OCF Interface set supported by this Resource", "items": { "enum": [ "oic.if.baseline", "oic.if.rw" ], "type": "string" }, "minItems": 1, "uniqueItems": true, "readOnly": true, "type": "array" }, "range": { "type": "array", "description": "Property. The valid range for the Property in the Resource as a number. The first value in the array is the minimum value, the second value in the array is the maximum value", "readOnly": true, "minItems": 2, "maxItems": 2, "items": { "type": "number" } }, "step": { "description": "Property. Step value across the defined range an integer when the range is a number. This is the increment for valid values across the range; so if range is 0.0..10.0 and step is 2.5 then valid values are 0.0,2.5,5.0,7.5,10.0", "readOnly": true, "type": "number" }, "precision": { "type": "number", "readOnly": true, "description": "Property. When exposed the value in 'precision' provides a +/- tolerance against the Properties in the Resource. Thus if a Property is UPDATED to a value and that Property then RETRIEVED, the RETRIEVED value is valid if in the range of the set value +/- precision" }, "type": { "type": "string", "enum": [ "Alarm" ], "description": "Property. NGSI entity type. It has to be Alarm" } } } ], "license": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md", "derivedFrom": "https://raw.githubusercontent.com/openconnectivityfoundation/IoTDataModels/master/Alarm.swagger.json", "required": [ "status", "id", "type" ] }