Platform Configuration¶
Title: Platform Configuration
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
Description: Voluptuous validation schema for Platform Configuration
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + platform | No | string | No | - | - |
| - name | No | string | No | - | - |
| - template_path | No | string | No | - | - |
| - media_path | No | string | No | - | - |
| - archive | No | object | No | - | - |
| - housekeeping | No | object | No | - | - |
| - dupe_check | No | object | No | - | - |
| - delivery | No | object | No | - | - |
| - action_groups | No | object | No | - | - |
| - recipients | No | array of object | No | - | - |
| - links | No | array of object | No | - | - |
| - scenarios | No | object | No | - | - |
| - methods | No | object | No | - | - |
| - cameras | No | array of object | No | - | - |
| - | No | object | No | - | - |
1. Property Platform Configuration > platform¶
| Type | string |
| Required | Yes |
2. Property Platform Configuration > name¶
| Type | string |
| Required | No |
3. Property Platform Configuration > template_path¶
| Type | string |
| Required | No |
| Default | "/config/templates/supernotify" |
4. Property Platform Configuration > media_path¶
| Type | string |
| Required | No |
| Default | "supernotify/media" |
5. Property Platform Configuration > archive¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Default | {"enabled": false} |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - archive_path | No | string | No | - | - |
| - enabled | No | string | No | - | - |
| - archive_days | No | integer | No | - | - |
| - archive_mqtt_topic | No | string | No | - | - |
| - archive_mqtt_qos | No | integer | No | - | - |
| - archive_mqtt_retain | No | string | No | - | - |
5.1. Property Platform Configuration > archive > archive_path¶
| Type | string |
| Required | No |
5.2. Property Platform Configuration > archive > enabled¶
| Type | string |
| Required | No |
| Default | false |
5.3. Property Platform Configuration > archive > archive_days¶
| Type | integer |
| Required | No |
| Default | 3 |
| Restrictions | |
|---|---|
| Minimum | ≥ 0 |
5.4. Property Platform Configuration > archive > archive_mqtt_topic¶
| Type | string |
| Required | No |
5.5. Property Platform Configuration > archive > archive_mqtt_qos¶
| Type | integer |
| Required | No |
| Default | 0 |
| Restrictions | |
|---|---|
| Minimum | ≥ 0 |
5.6. Property Platform Configuration > archive > archive_mqtt_retain¶
| Type | string |
| Required | No |
| Default | true |
6. Property Platform Configuration > housekeeping¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Default | {} |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - housekeeping_time | No | string | No | - | - |
6.1. Property Platform Configuration > housekeeping > housekeeping_time¶
| Type | string |
| Required | No |
| Default | "00:00:01" |
7. Property Platform Configuration > dupe_check¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Default | {} |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - ttl | No | integer | No | - | - |
| - size | No | integer | No | - | - |
| - dupe_policy | No | enum (of string) | No | - | - |
7.1. Property Platform Configuration > dupe_check > ttl¶
| Type | integer |
| Required | No |
| Restrictions | |
|---|---|
| Minimum | ≥ 0 |
7.2. Property Platform Configuration > dupe_check > size¶
| Type | integer |
| Required | No |
| Default | 100 |
| Restrictions | |
|---|---|
| Minimum | ≥ 0 |
7.3. Property Platform Configuration > dupe_check > dupe_policy¶
| Type | enum (of string) |
| Required | No |
| Default | "dupe_policy_message_title_same_or_lower_priority" |
Must be one of: * “dupe_policy_message_title_same_or_lower_priority” * “dupe_policy_none”
8. Property Platform Configuration > delivery¶
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
| Default | {} |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
8.1. Property Platform Configuration > delivery > additionalProperties¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - target | No | array of string | No | - | - |
| - action | No | string | No | - | - |
| - options | No | object | No | - | - |
| - data | No | object | No | - | - |
| - selection | No | array of enum (of string) | No | - | - |
| - priority | No | array of enum (of string) | No | - | - |
| - alias | No | string | No | - | - |
| + method | No | enum (of string) | No | - | - |
| - template | No | string | No | - | - |
| - default | No | string | No | - | - |
| - message | No | string | No | - | - |
| - title | No | string | No | - | - |
| - enabled | No | string | No | - | - |
| - occupancy | No | enum (of string) | No | - | - |
| - condition | No | string | No | - | - |
8.1.1. Property Platform Configuration > delivery > additionalProperties > target¶
| Type | array of string |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| target items | - |
8.1.1.1. Platform Configuration > delivery > additionalProperties > target > target items¶
| Type | string |
| Required | No |
8.1.2. Property Platform Configuration > delivery > additionalProperties > action¶
| Type | string |
| Required | No |
8.1.3. Property Platform Configuration > delivery > additionalProperties > options¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Default | {} |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
8.1.4. Property Platform Configuration > delivery > additionalProperties > data¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
8.1.5. Property Platform Configuration > delivery > additionalProperties > selection¶
| Type | array of enum (of string) |
| Required | No |
| Default | ["default"] |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| selection items | - |
8.1.5.1. Platform Configuration > delivery > additionalProperties > selection > selection items¶
| Type | enum (of string) |
| Required | No |
Must be one of: * “fallback_on_error” * “scenario” * “default” * “fallback”
8.1.6. Property Platform Configuration > delivery > additionalProperties > priority¶
| Type | array of enum (of string) |
| Required | No |
| Default | ["low", "medium", "high", "critical"] |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| priority items | - |
8.1.6.1. Platform Configuration > delivery > additionalProperties > priority > priority items¶
| Type | enum (of string) |
| Required | No |
Must be one of: * “low” * “medium” * “high” * “critical”
8.1.7. Property Platform Configuration > delivery > additionalProperties > alias¶
| Type | string |
| Required | No |
8.1.8. Property Platform Configuration > delivery > additionalProperties > method¶
| Type | enum (of string) |
| Required | Yes |
Must be one of: * “sms” * “alexa_devices” * “alexa_media_player” * “mobile_push” * “chime” * “email” * “media” * “persistent” * “generic”
8.1.9. Property Platform Configuration > delivery > additionalProperties > template¶
| Type | string |
| Required | No |
8.1.10. Property Platform Configuration > delivery > additionalProperties > default¶
| Type | string |
| Required | No |
| Default | false |
8.1.11. Property Platform Configuration > delivery > additionalProperties > message¶
| Type | string |
| Required | No |
8.1.12. Property Platform Configuration > delivery > additionalProperties > title¶
| Type | string |
| Required | No |
8.1.13. Property Platform Configuration > delivery > additionalProperties > enabled¶
| Type | string |
| Required | No |
| Default | true |
8.1.14. Property Platform Configuration > delivery > additionalProperties > occupancy¶
| Type | enum (of string) |
| Required | No |
| Default | "all" |
Must be one of: * “all_in” * “all_out” * “any_in” * “any_out” * “only_in” * “only_out” * “all” * “none”
8.1.15. Property Platform Configuration > delivery > additionalProperties > condition¶
| Type | string |
| Required | No |
9. Property Platform Configuration > action_groups¶
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
| Default | {} |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | array of object | No | - | - |
9.1. Property Platform Configuration > action_groups > additionalProperties¶
| Type | array of object |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| additionalProperties items | - |
9.1.1. Platform Configuration > action_groups > additionalProperties > additionalProperties items¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - action | No | string | No | - | - |
| - title | No | string | No | - | - |
| - uri | No | string | No | - | - |
| - icon | No | string | No | - | - |
| - | No | object | No | - | - |
9.1.1.1. Property Platform Configuration > action_groups > additionalProperties > additionalProperties items > action¶
| Type | string |
| Required | No |
9.1.1.2. Property Platform Configuration > action_groups > additionalProperties > additionalProperties items > title¶
| Type | string |
| Required | No |
9.1.1.3. Property Platform Configuration > action_groups > additionalProperties > additionalProperties items > uri¶
| Type | string |
| Required | No |
9.1.1.4. Property Platform Configuration > action_groups > additionalProperties > additionalProperties items > icon¶
| Type | string |
| Required | No |
10. Property Platform Configuration > recipients¶
| Type | array of object |
| Required | No |
| Default | [] |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| recipients items | - |
10.1. Platform Configuration > recipients > recipients items¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + person | No | string | No | - | - |
| - alias | No | string | No | - | - |
| No | string | No | - | - | |
| - target | No | array of string | No | - | - |
| - phone_number | No | string | No | - | - |
| - mobile_discovery | No | string | No | - | - |
| - mobile_devices | No | array of object | No | - | - |
| - delivery | No | object | No | - | - |
10.1.1. Property Platform Configuration > recipients > recipients items > person¶
| Type | string |
| Required | Yes |
10.1.2. Property Platform Configuration > recipients > recipients items > alias¶
| Type | string |
| Required | No |
10.1.3. Property Platform Configuration > recipients > recipients items > email¶
| Type | string |
| Required | No |
10.1.4. Property Platform Configuration > recipients > recipients items > target¶
| Type | array of string |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| target items | - |
10.1.4.1. Platform Configuration > recipients > recipients items > target > target items¶
| Type | string |
| Required | No |
10.1.5. Property Platform Configuration > recipients > recipients items > phone_number¶
| Type | string |
| Required | No |
10.1.6. Property Platform Configuration > recipients > recipients items > mobile_discovery¶
| Type | string |
| Required | No |
| Default | true |
10.1.7. Property Platform Configuration > recipients > recipients items > mobile_devices¶
| Type | array of object |
| Required | No |
| Default | [] |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| mobile_devices items | - |
10.1.7.1. Platform Configuration > recipients > recipients items > mobile_devices > mobile_devices items¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - manufacturer | No | string | No | - | - |
| - model | No | string | No | - | - |
| - notify_action | No | string | No | - | - |
| - device_tracker | No | string | No | - | - |
10.1.7.1.1. Property Platform Configuration > recipients > recipients items > mobile_devices > mobile_devices items > manufacturer¶
| Type | string |
| Required | No |
10.1.7.1.2. Property Platform Configuration > recipients > recipients items > mobile_devices > mobile_devices items > model¶
| Type | string |
| Required | No |
10.1.7.1.3. Property Platform Configuration > recipients > recipients items > mobile_devices > mobile_devices items > notify_action¶
| Type | string |
| Required | No |
10.1.7.1.4. Property Platform Configuration > recipients > recipients items > mobile_devices > mobile_devices items > device_tracker¶
| Type | string |
| Required | No |
10.1.8. Property Platform Configuration > recipients > recipients items > delivery¶
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
| Default | {} |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
10.1.8.1. Property Platform Configuration > recipients > recipients items > delivery > additionalProperties¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - target | No | array of string | No | - | - |
| - enabled | No | string | No | - | - |
| - data | No | object | No | - | - |
10.1.8.1.1. Property Platform Configuration > recipients > recipients items > delivery > additionalProperties > target¶
| Type | array of string |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| target items | - |
10.1.8.1.1.1. Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > target items¶
| Type | string |
| Required | No |
10.1.8.1.2. Property Platform Configuration > recipients > recipients items > delivery > additionalProperties > enabled¶
| Type | string |
| Required | No |
| Default | true |
10.1.8.1.3. Property Platform Configuration > recipients > recipients items > delivery > additionalProperties > data¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
11. Property Platform Configuration > links¶
| Type | array of object |
| Required | No |
| Default | [] |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| links items | - |
11.1. Platform Configuration > links > links items¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - id | No | string | No | - | - |
| + url | No | string | No | - | - |
| - icon | No | string | No | - | - |
| + description | No | string | No | - | - |
| - name | No | string | No | - | - |
11.1.1. Property Platform Configuration > links > links items > id¶
| Type | string |
| Required | No |
11.1.2. Property Platform Configuration > links > links items > url¶
| Type | string |
| Required | Yes |
11.1.3. Property Platform Configuration > links > links items > icon¶
| Type | string |
| Required | No |
11.1.4. Property Platform Configuration > links > links items > description¶
| Type | string |
| Required | Yes |
11.1.5. Property Platform Configuration > links > links items > name¶
| Type | string |
| Required | No |
12. Property Platform Configuration > scenarios¶
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
| Default | {} |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
12.1. Property Platform Configuration > scenarios > additionalProperties¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - alias | No | string | No | - | - |
| - condition | No | string | No | - | - |
| - media | No | object | No | - | - |
| - action_groups | No | array of string | No | - | - |
| - delivery_selection | No | enum (of string) | No | - | - |
| - delivery | No | object | No | - | - |
12.1.1. Property Platform Configuration > scenarios > additionalProperties > alias¶
| Type | string |
| Required | No |
12.1.2. Property Platform Configuration > scenarios > additionalProperties > condition¶
| Type | string |
| Required | No |
12.1.3. Property Platform Configuration > scenarios > additionalProperties > media¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - camera_entity_id | No | string | No | - | - |
| - camera_delay | No | integer | No | - | - |
| - camera_ptz_preset | No | Combination | No | - | - |
| - clip_url | No | string | No | - | - |
| - snapshot_url | No | string | No | - | - |
| - jpeg_opts | No | object | No | - | - |
12.1.3.1. Property Platform Configuration > scenarios > additionalProperties > media > camera_entity_id¶
| Type | string |
| Required | No |
12.1.3.2. Property Platform Configuration > scenarios > additionalProperties > media > camera_delay¶
| Type | integer |
| Required | No |
| Default | 0 |
12.1.3.3. Property Platform Configuration > scenarios > additionalProperties > media > camera_ptz_preset¶
| Type | combining |
| Required | No |
| Additional properties | Any type allowed |
| Any of(Option) |
|---|
| item 0 |
| item 1 |
12.1.3.3.1. Property Platform Configuration > scenarios > additionalProperties > media > camera_ptz_preset > anyOf > item 0¶
| Type | integer |
| Required | No |
| Restrictions | |
|---|---|
| Minimum | ≥ 0 |
12.1.3.3.2. Property Platform Configuration > scenarios > additionalProperties > media > camera_ptz_preset > anyOf > item 1¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
12.1.3.4. Property Platform Configuration > scenarios > additionalProperties > media > clip_url¶
| Type | string |
| Required | No |
12.1.3.5. Property Platform Configuration > scenarios > additionalProperties > media > snapshot_url¶
| Type | string |
| Required | No |
12.1.3.6. Property Platform Configuration > scenarios > additionalProperties > media > jpeg_opts¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
12.1.4. Property Platform Configuration > scenarios > additionalProperties > action_groups¶
| Type | array of string |
| Required | No |
| Default | [] |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| action_groups items | - |
12.1.4.1. Platform Configuration > scenarios > additionalProperties > action_groups > action_groups items¶
| Type | string |
| Required | No |
12.1.5. Property Platform Configuration > scenarios > additionalProperties > delivery_selection¶
| Type | enum (of string) |
| Required | No |
Must be one of: * “explicit” * “fixed” * “implicit”
12.1.6. Property Platform Configuration > scenarios > additionalProperties > delivery¶
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
| Default | {} |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
12.1.6.1. Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - target | No | array of string | No | - | - |
| - enabled | No | string | No | - | - |
| - data | No | object | No | - | - |
12.1.6.1.1. Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target¶
| Type | array of string |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| target items | - |
12.1.6.1.1.1. Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > target items¶
| Type | string |
| Required | No |
12.1.6.1.2. Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > enabled¶
| Type | string |
| Required | No |
| Default | true |
12.1.6.1.3. Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > data¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
13. Property Platform Configuration > methods¶
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
| Default | {} |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
13.1. Property Platform Configuration > methods > additionalProperties¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - targets_required | No | string | No | - | - |
| - device_domain | No | array of string | No | - | - |
| - device_discovery | No | string | No | - | - |
| - default | No | object | No | - | - |
13.1.1. Property Platform Configuration > methods > additionalProperties > targets_required¶
| Type | string |
| Required | No |
13.1.2. Property Platform Configuration > methods > additionalProperties > device_domain¶
| Type | array of string |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| device_domain items | - |
13.1.2.1. Platform Configuration > methods > additionalProperties > device_domain > device_domain items¶
| Type | string |
| Required | No |
13.1.3. Property Platform Configuration > methods > additionalProperties > device_discovery¶
| Type | string |
| Required | No |
13.1.4. Property Platform Configuration > methods > additionalProperties > default¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - target | No | array of string | No | - | - |
| - action | No | string | No | - | - |
| - options | No | object | No | - | - |
| - data | No | object | No | - | - |
| - selection | No | array of enum (of string) | No | - | - |
| - priority | No | array of enum (of string) | No | - | - |
13.1.4.1. Property Platform Configuration > methods > additionalProperties > default > target¶
| Type | array of string |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| target items | - |
13.1.4.1.1. Platform Configuration > methods > additionalProperties > default > target > target items¶
| Type | string |
| Required | No |
13.1.4.2. Property Platform Configuration > methods > additionalProperties > default > action¶
| Type | string |
| Required | No |
13.1.4.3. Property Platform Configuration > methods > additionalProperties > default > options¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Default | {} |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
13.1.4.4. Property Platform Configuration > methods > additionalProperties > default > data¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
13.1.4.5. Property Platform Configuration > methods > additionalProperties > default > selection¶
| Type | array of enum (of string) |
| Required | No |
| Default | ["default"] |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| selection items | - |
13.1.4.5.1. Platform Configuration > methods > additionalProperties > default > selection > selection items¶
| Type | enum (of string) |
| Required | No |
Must be one of: * “fallback_on_error” * “scenario” * “default” * “fallback”
13.1.4.6. Property Platform Configuration > methods > additionalProperties > default > priority¶
| Type | array of enum (of string) |
| Required | No |
| Default | ["low", "medium", "high", "critical"] |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| priority items | - |
13.1.4.6.1. Platform Configuration > methods > additionalProperties > default > priority > priority items¶
| Type | enum (of string) |
| Required | No |
Must be one of: * “low” * “medium” * “high” * “critical”
14. Property Platform Configuration > cameras¶
| Type | array of object |
| Required | No |
| Default | [] |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| cameras items | - |
14.1. Platform Configuration > cameras > cameras items¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + camera | No | string | No | - | - |
| - alt_camera | No | array of string | No | - | - |
| - alias | No | string | No | - | - |
| - url | No | string | No | - | - |
| - device_tracker | No | string | No | - | - |
| - ptz_default_preset | No | Combination | No | - | - |
| - ptz_delay | No | integer | No | - | - |
| - ptz_method | No | enum (of string) | No | - | - |
14.1.1. Property Platform Configuration > cameras > cameras items > camera¶
| Type | string |
| Required | Yes |
14.1.2. Property Platform Configuration > cameras > cameras items > alt_camera¶
| Type | array of string |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| alt_camera items | - |
14.1.2.1. Platform Configuration > cameras > cameras items > alt_camera > alt_camera items¶
| Type | string |
| Required | No |
14.1.3. Property Platform Configuration > cameras > cameras items > alias¶
| Type | string |
| Required | No |
14.1.4. Property Platform Configuration > cameras > cameras items > url¶
| Type | string |
| Required | No |
14.1.5. Property Platform Configuration > cameras > cameras items > device_tracker¶
| Type | string |
| Required | No |
14.1.6. Property Platform Configuration > cameras > cameras items > ptz_default_preset¶
| Type | combining |
| Required | No |
| Additional properties | Any type allowed |
| Default | 1 |
| Any of(Option) |
|---|
| item 0 |
| item 1 |
14.1.6.1. Property Platform Configuration > cameras > cameras items > ptz_default_preset > anyOf > item 0¶
| Type | integer |
| Required | No |
| Restrictions | |
|---|---|
| Minimum | ≥ 0 |
14.1.6.2. Property Platform Configuration > cameras > cameras items > ptz_default_preset > anyOf > item 1¶
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
14.1.7. Property Platform Configuration > cameras > cameras items > ptz_delay¶
| Type | integer |
| Required | No |
| Default | 0 |
14.1.8. Property Platform Configuration > cameras > cameras items > ptz_method¶
| Type | enum (of string) |
| Required | No |
| Default | "onvif" |
Must be one of: * “onvif” * “frigate”
Generated using json-schema-for-humans on 2025-10-26 at 08:54:32 +0000