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.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| sensor | SensorOptions | Yes | Configuration options for the sensor. |
Property Details
SensorOptions
Configuration options for a sensor.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| name | string | No | The name of the model | |
| description | string | No | A brief description of what the model does. | |
| metadata | ResourceMetadata | No | Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources. | |
| automation | string | No | Name of the parent automation that the sensor belongs to. | |
| config | object | Yes | Configuration for the sensor. | |
| type | string | Yes | Type 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.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| source | ResourceLocation | No | The origin or source information for the resource. | |
| source_event_uuid | string | No | UUID of the event that is associated with creation of this resource. |
ResourceLocation
The origin or source information for the resource.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| path | string | Yes | Path within repository files where the resource is defined. | |
| first_line_number | integer | No | First line number within path file where the resource is defined. |