Skip to content

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
+ 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
- transports No object No
- cameras No array of object No
- No object No

Property Platform Configuration > platform

Type string
Required Yes

Property Platform Configuration > name

Type string
Required No

Property Platform Configuration > template_path

Type string
Required No
Default "/config/templates/supernotify"

Property Platform Configuration > media_path

Type string
Required No
Default "supernotify/media"

Property Platform Configuration > archive

Type object
Required No
Additional properties Any type allowed
Default {"enabled": false}
Property Pattern Type Deprecated
- file_path No string No
- enabled No string No
- file_retention_days No integer No
- mqtt_topic No string No
- mqtt_qos No integer No
- mqtt_retain No string No
- purge_interval No integer No
- debug No string No

Property Platform Configuration > archive > file_path

Type string
Required No

Property Platform Configuration > archive > enabled

Type string
Required No
Default false

Property Platform Configuration > archive > file_retention_days

Type integer
Required No
Default 3
Restrictions
Minimum ≥ 0

Property Platform Configuration > archive > mqtt_topic

Type string
Required No

Property Platform Configuration > archive > mqtt_qos

Type integer
Required No
Default 0
Restrictions
Minimum ≥ 0

Property Platform Configuration > archive > mqtt_retain

Type string
Required No
Default true

Property Platform Configuration > archive > purge_interval

Type integer
Required No
Default 60
Restrictions
Minimum ≥ 0

Property Platform Configuration > archive > debug

Type string
Required No
Default false

Property Platform Configuration > housekeeping

Type object
Required No
Additional properties Any type allowed
Default {}
Property Pattern Type Deprecated
- housekeeping_time No string No

Property Platform Configuration > housekeeping > housekeeping_time

Type string
Required No
Default "00:00:01"

Property Platform Configuration > dupe_check

Type object
Required No
Additional properties Any type allowed
Default {}
Property Pattern Type Deprecated
- ttl No integer No
- size No integer No
- dupe_policy No enum (of string) No

Property Platform Configuration > dupe_check > ttl

Type integer
Required No
Restrictions
Minimum ≥ 0

Property Platform Configuration > dupe_check > size

Type integer
Required No
Default 100
Restrictions
Minimum ≥ 0

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"

Property Platform Configuration > delivery

Type object
Required No
Additional properties Each additional property must conform to the schema
Default {}
Property Pattern Type Deprecated
- No object No

Property Platform Configuration > delivery > additionalProperties

Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- action No string No
- debug No boolean No
- options No object No
- data No object No
- target No Combination No
- target_required No Combination No
- target_usage No enum (of string) No
- selection No array of enum (of string) No
- priority No array of enum (of string) No
- selection_rank No enum (of string) No
- alias No string No
+ transport No enum (of string) No
- template No string No
- message No string No
- title No string No
- enabled No boolean No
- occupancy No enum (of string) No
- condition No string No

Property Platform Configuration > delivery > additionalProperties > action

Type string
Required No

Property Platform Configuration > delivery > additionalProperties > debug

Type boolean
Required No

Property Platform Configuration > delivery > additionalProperties > options

Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No

Property Platform Configuration > delivery > additionalProperties > data

Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No

Property Platform Configuration > delivery > additionalProperties > target

Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
item 2
item 3
item 4
Property Platform Configuration > delivery > additionalProperties > target > anyOf > item 0
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- No array of string No
Property Platform Configuration > delivery > additionalProperties > target > anyOf > item 0 > additionalProperties
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
additionalProperties items -
Platform Configuration > delivery > additionalProperties > target > anyOf > item 0 > additionalProperties > additionalProperties items
Type string
Required No
Property Platform Configuration > delivery > additionalProperties > target > anyOf > item 1
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- No string No
Property Platform Configuration > delivery > additionalProperties > target > anyOf > item 1 > additionalProperties
Type string
Required No
Property Platform Configuration > delivery > additionalProperties > target > anyOf > item 2
Type string
Required No
Property Platform Configuration > delivery > additionalProperties > target > anyOf > item 3
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
item 3 items -
Platform Configuration > delivery > additionalProperties > target > anyOf > item 3 > item 3 items
Type string
Required No
Property Platform Configuration > delivery > additionalProperties > target > anyOf > item 4
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- entity_id No array of string No
- device_id No array of string No
- area_id No array of string No
- floor_id No array of string No
- label_id No array of string No
Property Platform Configuration > delivery > additionalProperties > target > anyOf > item 4 > entity_id
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
entity_id items -
Platform Configuration > delivery > additionalProperties > target > anyOf > item 4 > entity_id > entity_id items
Type string
Required No
Property Platform Configuration > delivery > additionalProperties > target > anyOf > item 4 > device_id
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_id items -
Platform Configuration > delivery > additionalProperties > target > anyOf > item 4 > device_id > device_id items
Type string
Required No
Property Platform Configuration > delivery > additionalProperties > target > anyOf > item 4 > area_id
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
area_id items -
Platform Configuration > delivery > additionalProperties > target > anyOf > item 4 > area_id > area_id items
Type string
Required No
Property Platform Configuration > delivery > additionalProperties > target > anyOf > item 4 > floor_id
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
floor_id items -
Platform Configuration > delivery > additionalProperties > target > anyOf > item 4 > floor_id > floor_id items
Type string
Required No
Property Platform Configuration > delivery > additionalProperties > target > anyOf > item 4 > label_id
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
label_id items -
Platform Configuration > delivery > additionalProperties > target > anyOf > item 4 > label_id > label_id items
Type string
Required No

Property Platform Configuration > delivery > additionalProperties > target_required

Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
Property Platform Configuration > delivery > additionalProperties > target_required > anyOf > item 0
Type object
Required No
Additional properties Any type allowed
Property Platform Configuration > delivery > additionalProperties > target_required > anyOf > item 1
Type enum (of string)
Required No

Must be one of: * "always" * "never" * "optional"

Property Platform Configuration > delivery > additionalProperties > target_usage

Type enum (of string)
Required No

Must be one of: * "no_delivery" * "no_action" * "merge_delivery" * "merge_always" * "fixed"

Property Platform Configuration > delivery > additionalProperties > selection

Type array of enum (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
selection items -
Platform Configuration > delivery > additionalProperties > selection > selection items
Type enum (of string)
Required No

Must be one of: * "fallback_on_error" * "scenario" * "default" * "fallback"

Property Platform Configuration > delivery > additionalProperties > priority

Type array of enum (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
priority items -
Platform Configuration > delivery > additionalProperties > priority > priority items
Type enum (of string)
Required No

Must be one of: * "low" * "medium" * "high" * "critical"

Property Platform Configuration > delivery > additionalProperties > selection_rank

Type enum (of string)
Required No

Must be one of: * "ANY" * "FIRST" * "LAST"

Property Platform Configuration > delivery > additionalProperties > alias

Type string
Required No

Property Platform Configuration > delivery > additionalProperties > transport

Type enum (of string)
Required Yes

Must be one of: * "sms" * "mqtt" * "alexa_devices" * "alexa_media_player" * "mobile_push" * "chime" * "email" * "media" * "persistent" * "generic" * "notify_entity"

Property Platform Configuration > delivery > additionalProperties > template

Type string
Required No

Property Platform Configuration > delivery > additionalProperties > message

Type string
Required No

Property Platform Configuration > delivery > additionalProperties > title

Type string
Required No

Property Platform Configuration > delivery > additionalProperties > enabled

Type boolean
Required No

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"

Property Platform Configuration > delivery > additionalProperties > condition

Type string
Required No

Property Platform Configuration > action_groups

Type object
Required No
Additional properties Each additional property must conform to the schema
Default {}
Property Pattern Type Deprecated
- No array of object No

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 -

Platform Configuration > action_groups > additionalProperties > additionalProperties items

Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- action No string No
- title No string No
- uri No string No
- icon No string No
- No object No
Property Platform Configuration > action_groups > additionalProperties > additionalProperties items > action
Type string
Required No
Property Platform Configuration > action_groups > additionalProperties > additionalProperties items > title
Type string
Required No
Property Platform Configuration > action_groups > additionalProperties > additionalProperties items > uri
Type string
Required No
Property Platform Configuration > action_groups > additionalProperties > additionalProperties items > icon
Type string
Required No

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 -

Platform Configuration > recipients > recipients items

Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
+ person No string No
- alias No string No
- email No string No
- target No Combination No
- phone_number No string No
- mobile_discovery No boolean No
- mobile_devices No array of object No
- delivery No object No

Property Platform Configuration > recipients > recipients items > person

Type string
Required Yes

Property Platform Configuration > recipients > recipients items > alias

Type string
Required No

Property Platform Configuration > recipients > recipients items > email

Type string
Required No

Property Platform Configuration > recipients > recipients items > target

Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
item 2
item 3
item 4
Property Platform Configuration > recipients > recipients items > target > anyOf > item 0
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- No array of string No
Property Platform Configuration > recipients > recipients items > target > anyOf > item 0 > additionalProperties
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
additionalProperties items -
Platform Configuration > recipients > recipients items > target > anyOf > item 0 > additionalProperties > additionalProperties items
Type string
Required No
Property Platform Configuration > recipients > recipients items > target > anyOf > item 1
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- No string No
Property Platform Configuration > recipients > recipients items > target > anyOf > item 1 > additionalProperties
Type string
Required No
Property Platform Configuration > recipients > recipients items > target > anyOf > item 2
Type string
Required No
Property Platform Configuration > recipients > recipients items > target > anyOf > item 3
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
item 3 items -
Platform Configuration > recipients > recipients items > target > anyOf > item 3 > item 3 items
Type string
Required No
Property Platform Configuration > recipients > recipients items > target > anyOf > item 4
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- entity_id No array of string No
- device_id No array of string No
- area_id No array of string No
- floor_id No array of string No
- label_id No array of string No
Property Platform Configuration > recipients > recipients items > target > anyOf > item 4 > entity_id
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
entity_id items -
Platform Configuration > recipients > recipients items > target > anyOf > item 4 > entity_id > entity_id items
Type string
Required No
Property Platform Configuration > recipients > recipients items > target > anyOf > item 4 > device_id
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_id items -
Platform Configuration > recipients > recipients items > target > anyOf > item 4 > device_id > device_id items
Type string
Required No
Property Platform Configuration > recipients > recipients items > target > anyOf > item 4 > area_id
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
area_id items -
Platform Configuration > recipients > recipients items > target > anyOf > item 4 > area_id > area_id items
Type string
Required No
Property Platform Configuration > recipients > recipients items > target > anyOf > item 4 > floor_id
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
floor_id items -
Platform Configuration > recipients > recipients items > target > anyOf > item 4 > floor_id > floor_id items
Type string
Required No
Property Platform Configuration > recipients > recipients items > target > anyOf > item 4 > label_id
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
label_id items -
Platform Configuration > recipients > recipients items > target > anyOf > item 4 > label_id > label_id items
Type string
Required No

Property Platform Configuration > recipients > recipients items > phone_number

Type string
Required No

Property Platform Configuration > recipients > recipients items > mobile_discovery

Type boolean
Required No
Default true

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 -
Platform Configuration > recipients > recipients items > mobile_devices > mobile_devices items
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- manufacturer No string No
- model No string No
- mobile_app_id No string No
- device_tracker No string No
Property Platform Configuration > recipients > recipients items > mobile_devices > mobile_devices items > manufacturer
Type string
Required No
Property Platform Configuration > recipients > recipients items > mobile_devices > mobile_devices items > model
Type string
Required No
Property Platform Configuration > recipients > recipients items > mobile_devices > mobile_devices items > mobile_app_id
Type string
Required No
Property Platform Configuration > recipients > recipients items > mobile_devices > mobile_devices items > device_tracker
Type string
Required No

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
- No object No
Property Platform Configuration > recipients > recipients items > delivery > additionalProperties
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- target No Combination No
- enabled No boolean No
- data No object No
Property Platform Configuration > recipients > recipients items > delivery > additionalProperties > target
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
item 2
item 3
item 4
Property Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- No array of string No
Property Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > additionalProperties
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
additionalProperties items -
Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 0 > additionalProperties > additionalProperties items
Type string
Required No
Property Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 1
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- No string No
Property Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 1 > additionalProperties
Type string
Required No
Property Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 2
Type string
Required No
Property Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 3
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
item 3 items -
Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 3 > item 3 items
Type string
Required No
Property Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 4
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- entity_id No array of string No
- device_id No array of string No
- area_id No array of string No
- floor_id No array of string No
- label_id No array of string No
Property Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 4 > entity_id
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
entity_id items -
Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 4 > entity_id > entity_id items
Type string
Required No
Property Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 4 > device_id
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_id items -
Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 4 > device_id > device_id items
Type string
Required No
Property Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 4 > area_id
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
area_id items -
Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 4 > area_id > area_id items
Type string
Required No
Property Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 4 > floor_id
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
floor_id items -
Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 4 > floor_id > floor_id items
Type string
Required No
Property Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 4 > label_id
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
label_id items -
Platform Configuration > recipients > recipients items > delivery > additionalProperties > target > anyOf > item 4 > label_id > label_id items
Type string
Required No
Property Platform Configuration > recipients > recipients items > delivery > additionalProperties > enabled
Type boolean
Required No
Default true
Property Platform Configuration > recipients > recipients items > delivery > additionalProperties > data
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No
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 -
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- id No string No
+ url No string No
- icon No string No
+ description No string No
- name No string No
Type string
Required No
Type string
Required Yes
Type string
Required No
Type string
Required Yes
Type string
Required No

Property Platform Configuration > scenarios

Type object
Required No
Additional properties Each additional property must conform to the schema
Default {}
Property Pattern Type Deprecated
- No object No

Property Platform Configuration > scenarios > additionalProperties

Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- alias No string No
- enabled No boolean 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

Property Platform Configuration > scenarios > additionalProperties > alias

Type string
Required No

Property Platform Configuration > scenarios > additionalProperties > enabled

Type boolean
Required No
Default true

Property Platform Configuration > scenarios > additionalProperties > condition

Type string
Required No

Property Platform Configuration > scenarios > additionalProperties > media

Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- 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
Property Platform Configuration > scenarios > additionalProperties > media > camera_entity_id
Type string
Required No
Property Platform Configuration > scenarios > additionalProperties > media > camera_delay
Type integer
Required No
Default 0
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
Property Platform Configuration > scenarios > additionalProperties > media > camera_ptz_preset > anyOf > item 0
Type integer
Required No
Restrictions
Minimum ≥ 0
Property Platform Configuration > scenarios > additionalProperties > media > camera_ptz_preset > anyOf > item 1
Type object
Required No
Additional properties Any type allowed
Property Platform Configuration > scenarios > additionalProperties > media > clip_url
Type string
Required No
Property Platform Configuration > scenarios > additionalProperties > media > snapshot_url
Type string
Required No
Property Platform Configuration > scenarios > additionalProperties > media > jpeg_opts
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No

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 -
Platform Configuration > scenarios > additionalProperties > action_groups > action_groups items
Type string
Required No

Property Platform Configuration > scenarios > additionalProperties > delivery_selection

Type enum (of string)
Required No
Default "implicit"

Must be one of: * "implicit" * "explicit"

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
- No object No
Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- target No Combination No
- enabled No boolean No
- data No object No
Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
item 2
item 3
item 4
Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- No array of string No
Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > additionalProperties
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
additionalProperties items -
Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 0 > additionalProperties > additionalProperties items
Type string
Required No
Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 1
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- No string No
Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 1 > additionalProperties
Type string
Required No
Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 2
Type string
Required No
Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 3
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
item 3 items -
Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 3 > item 3 items
Type string
Required No
Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 4
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- entity_id No array of string No
- device_id No array of string No
- area_id No array of string No
- floor_id No array of string No
- label_id No array of string No
Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 4 > entity_id
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
entity_id items -
Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 4 > entity_id > entity_id items
Type string
Required No
Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 4 > device_id
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_id items -
Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 4 > device_id > device_id items
Type string
Required No
Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 4 > area_id
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
area_id items -
Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 4 > area_id > area_id items
Type string
Required No
Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 4 > floor_id
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
floor_id items -
Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 4 > floor_id > floor_id items
Type string
Required No
Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 4 > label_id
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
label_id items -
Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > target > anyOf > item 4 > label_id > label_id items
Type string
Required No
Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > enabled
Type boolean
Required No
Default true
Property Platform Configuration > scenarios > additionalProperties > delivery > additionalProperties > data
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No

Property Platform Configuration > transports

Type object
Required No
Additional properties Each additional property must conform to the schema
Default {}
Property Pattern Type Deprecated
- No object No

Property Platform Configuration > transports > additionalProperties

Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- alias No string No
- device_domain No array of string No
- device_discovery No boolean No
- enabled No boolean No
- delivery_defaults No object No

Property Platform Configuration > transports > additionalProperties > alias

Type string
Required No

Property Platform Configuration > transports > 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 -
Platform Configuration > transports > additionalProperties > device_domain > device_domain items
Type string
Required No

Property Platform Configuration > transports > additionalProperties > device_discovery

Type boolean
Required No
Default false

Property Platform Configuration > transports > additionalProperties > enabled

Type boolean
Required No
Default true

Property Platform Configuration > transports > additionalProperties > delivery_defaults

Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- action No string No
- debug No string No
- options No object No
- data No object No
- target No Combination No
- target_required No Combination No
- target_usage No enum (of string) No
- selection No array of enum (of string) No
- priority No array of enum (of string) No
- selection_rank No enum (of string) No
Property Platform Configuration > transports > additionalProperties > delivery_defaults > action
Type string
Required No
Property Platform Configuration > transports > additionalProperties > delivery_defaults > debug
Type string
Required No
Property Platform Configuration > transports > additionalProperties > delivery_defaults > options
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No
Property Platform Configuration > transports > additionalProperties > delivery_defaults > data
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No
Property Platform Configuration > transports > additionalProperties > delivery_defaults > target
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
item 2
item 3
item 4
Property Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- No array of string No
Property Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > additionalProperties
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
additionalProperties items -
Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 0 > additionalProperties > additionalProperties items
Type string
Required No
Property Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 1
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- No string No
Property Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 1 > additionalProperties
Type string
Required No
Property Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 2
Type string
Required No
Property Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 3
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
item 3 items -
Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 3 > item 3 items
Type string
Required No
Property Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 4
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- entity_id No array of string No
- device_id No array of string No
- area_id No array of string No
- floor_id No array of string No
- label_id No array of string No
Property Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 4 > entity_id
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
entity_id items -
Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 4 > entity_id > entity_id items
Type string
Required No
Property Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 4 > device_id
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_id items -
Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 4 > device_id > device_id items
Type string
Required No
Property Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 4 > area_id
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
area_id items -
Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 4 > area_id > area_id items
Type string
Required No
Property Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 4 > floor_id
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
floor_id items -
Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 4 > floor_id > floor_id items
Type string
Required No
Property Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 4 > label_id
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
label_id items -
Platform Configuration > transports > additionalProperties > delivery_defaults > target > anyOf > item 4 > label_id > label_id items
Type string
Required No
Property Platform Configuration > transports > additionalProperties > delivery_defaults > target_required
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
Property Platform Configuration > transports > additionalProperties > delivery_defaults > target_required > anyOf > item 0
Type object
Required No
Additional properties Any type allowed
Property Platform Configuration > transports > additionalProperties > delivery_defaults > target_required > anyOf > item 1
Type enum (of string)
Required No

Must be one of: * "always" * "never" * "optional"

Property Platform Configuration > transports > additionalProperties > delivery_defaults > target_usage
Type enum (of string)
Required No

Must be one of: * "no_delivery" * "no_action" * "merge_delivery" * "merge_always" * "fixed"

Property Platform Configuration > transports > additionalProperties > delivery_defaults > selection
Type array of enum (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
selection items -
Platform Configuration > transports > additionalProperties > delivery_defaults > selection > selection items
Type enum (of string)
Required No

Must be one of: * "fallback_on_error" * "scenario" * "default" * "fallback"

Property Platform Configuration > transports > additionalProperties > delivery_defaults > priority
Type array of enum (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
priority items -
Platform Configuration > transports > additionalProperties > delivery_defaults > priority > priority items
Type enum (of string)
Required No

Must be one of: * "low" * "medium" * "high" * "critical"

Property Platform Configuration > transports > additionalProperties > delivery_defaults > selection_rank
Type enum (of string)
Required No

Must be one of: * "ANY" * "FIRST" * "LAST"

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 -

Platform Configuration > cameras > cameras items

Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
+ 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

Property Platform Configuration > cameras > cameras items > camera

Type string
Required Yes

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 -
Platform Configuration > cameras > cameras items > alt_camera > alt_camera items
Type string
Required No

Property Platform Configuration > cameras > cameras items > alias

Type string
Required No

Property Platform Configuration > cameras > cameras items > url

Type string
Required No

Property Platform Configuration > cameras > cameras items > device_tracker

Type string
Required No

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
Property Platform Configuration > cameras > cameras items > ptz_default_preset > anyOf > item 0
Type integer
Required No
Restrictions
Minimum ≥ 0
Property Platform Configuration > cameras > cameras items > ptz_default_preset > anyOf > item 1
Type object
Required No
Additional properties Any type allowed

Property Platform Configuration > cameras > cameras items > ptz_delay

Type integer
Required No
Default 0

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-11-21 at 23:32:28 +0000