Skip to main content
Version: 3.0.0

Sensor

A sensor detects and/or measures conditions and sends signals to trigger actions as part of an automation. Common sensors include schedule-based sensors, user-defined customizable sensors, etc.

Sensor​

Below are the properties for the Sensor. Each property links to the specific details section further down in this page.

PropertyDefaultTypeRequiredDescription
sensorSensorOptionsYesConfiguration options for the sensor.

Property Details​

SensorOptions​

Configuration options for a sensor.

PropertyDefaultTypeRequiredDescription
descriptionstring
NoA brief description of what the model does.
metadataResourceMetadata
NoMeta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.
namestringYesThe name of the model
configobject with property values of type None
YesConfiguration for the sensor.
typestringYesType of sensor.

ResourceMetadata​

Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.

PropertyDefaultTypeRequiredDescription
sourceResourceLocation
NoThe origin or source information for the resource.
source_event_uuidstring
NoUUID of the event that is associated with creation of this resource.

ResourceLocation​

The origin or source information for the resource.

PropertyDefaultTypeRequiredDescription
pathstringYesPath within repository files where the resource is defined.
first_line_numberinteger
NoFirst line number within path file where the resource is defined.