notification.bacnet

BACnet notification

type	object
properties
instance	The instance of the notification class to subscribe on. If it doesn’t exist the subscription will be ignored.
	type	integer
	minimum	0
isTemplateGeneratedByOspComposer	Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.
	type	string
linkedAction	The action to execute when an notification is received. For more information about actions ↗️.
	LinkedActionConfigurationEntity
linkedDevice	The BACnet device (device.bacnet) on which the event subscription will be done. For example root.bacnet.device1 could be the OnSphere path of the BACnet device. Learn more about BACnet ↗️.
	type	string
onTriggerObjectPropertiesToFetch	Represents a selection of BACnet properties. The properties can be selected either by specifying a range of property identifiers or by providing an explicit list of property names. Only one selection method can be used at a time. Learn more about BACnet ↗️. Learn more about usage for properties subscription↗️. Learn more about usage for usage in notifications↗️.
	oneOf	type	object
		properties
		range	Represents a selection of BACnet property identifiers. You can select a single property, e.g., “85”, multiple properties, e.g., “85,87,92” or a range of properties, e.g., “80..90”. For ranges, the start or end can be left open, e.g., “..100” or “75..”. All these methods can be combined, e.g., “60,65..70,85,90..”. Learn more about BACnet ↗️.
			type	string
		additionalProperties	False
		type	object
		properties
		names	Represents an explicit list of BACnet property names. This list contains standard BACnet property identifiers and allows precise selection of individual properties. Learn more about BACnet ↗️.
			type	array
			items	type	string
				enum	ACKED_TRANSITIONS, ACK_REQUIRED, ACTION, ACTION_TEXT, ACTIVE_TEXT, ACTIVE_VT_SESSIONS, ALARM_VALUE, ALARM_VALUES, ALL, ALL_WRITES_SUCCESSFUL, APDU_SEGMENT_TIMEOUT, APDU_TIMEOUT, APPLICATION_SOFTWARE_VERSION, ARCHIVE, BIAS, CHANGE_OF_STATE_COUNT, CHANGE_OF_STATE_TIME, NOTIFICATION_CLASS, CONTROLLED_VARIABLE_REFERENCE, CONTROLLED_VARIABLE_UNITS, CONTROLLED_VARIABLE_VALUE, COV_INCREMENT, DATE_LIST, DAYLIGHT_SAVINGS_STATUS, DEADBAND, DERIVATIVE_CONSTANT, DERIVATIVE_CONSTANT_UNITS, DESCRIPTION, DESCRIPTION_OF_HALT, DEVICE_ADDRESS_BINDING, DEVICE_TYPE, EFFECTIVE_PERIOD, ELAPSED_ACTIVE_TIME, ERROR_LIMIT, EVENT_ENABLE, EVENT_STATE, EVENT_TYPE, EXCEPTION_SCHEDULE, FAULT_VALUES, FEEDBACK_VALUE, FILE_ACCESS_METHOD, FILE_SIZE, FILE_TYPE, FIRMWARE_REVISION, HIGH_LIMIT, INACTIVE_TEXT, IN_PROCESS, INSTANCE_OF, INTEGRAL_CONSTANT, INTEGRAL_CONSTANT_UNITS, LIMIT_ENABLE, LIST_OF_GROUP_MEMBERS, LIST_OF_OBJECT_PROPERTY_REFERENCES, LOCAL_DATE, LOCAL_TIME, LOCATION, LOW_LIMIT, MANIPULATED_VARIABLE_REFERENCE, MAXIMUM_OUTPUT, MAX_APDU_LENGTH_ACCEPTED, MAX_INFO_FRAMES, MAX_MASTER, MAX_PRES_VALUE, MINIMUM_OFF_TIME, MINIMUM_ON_TIME, MINIMUM_OUTPUT, MIN_PRES_VALUE, MODEL_NAME, MODIFICATION_DATE, NOTIFY_TYPE, NUMBER_OF_APDU_RETRIES, NUMBER_OF_STATES, OBJECT_IDENTIFIER, OBJECT_LIST, OBJECT_NAME, OBJECT_PROPERTY_REFERENCE, OBJECT_TYPE, OPTIONAL, OUT_OF_SERVICE, OUTPUT_UNITS, EVENT_PARAMETERS, POLARITY, PRESENT_VALUE, PRIORITY, PRIORITY_ARRAY, PRIORITY_FOR_WRITING, PROCESS_IDENTIFIER, PROGRAM_CHANGE, PROGRAM_LOCATION, PROGRAM_STATE, PROPORTIONAL_CONSTANT, PROPORTIONAL_CONSTANT_UNITS, PROTOCOL_OBJECT_TYPES_SUPPORTED, PROTOCOL_SERVICES_SUPPORTED, PROTOCOL_VERSION, READ_ONLY, REASON_FOR_HALT, RECIPIENT_LIST, RELIABILITY, RELINQUISH_DEFAULT, REQUIRED, RESOLUTION, SEGMENTATION_SUPPORTED, SETPOINT, SETPOINT_REFERENCE, STATE_TEXT, STATUS_FLAGS, SYSTEM_STATUS, TIME_DELAY, TIME_OF_ACTIVE_TIME_RESET, TIME_OF_STATE_COUNT_RESET, TIME_SYNCHRONIZATION_RECIPIENTS, UNITS, UPDATE_INTERVAL, UTC_OFFSET, VENDOR_IDENTIFIER, VENDOR_NAME, VT_CLASSES_SUPPORTED, WEEKLY_SCHEDULE, ATTEMPTED_SAMPLES, AVERAGE_VALUE, BUFFER_SIZE, CLIENT_COV_INCREMENT, COV_RESUBSCRIPTION_INTERVAL, EVENT_TIME_STAMPS, LOG_BUFFER, LOG_DEVICE_OBJECT_PROPERTY, ENABLE, LOG_INTERVAL, MAXIMUM_VALUE, MINIMUM_VALUE, NOTIFICATION_THRESHOLD, PROTOCOL_REVISION, RECORDS_SINCE_NOTIFICATION, RECORD_COUNT, START_TIME, STOP_TIME, STOP_WHEN_FULL, TOTAL_RECORD_COUNT, VALID_SAMPLES, WINDOW_INTERVAL, WINDOW_SAMPLES, MAXIMUM_VALUE_TIMESTAMP, MINIMUM_VALUE_TIMESTAMP, VARIANCE_VALUE, ACTIVE_COV_SUBSCRIPTIONS, BACKUP_FAILURE_TIMEOUT, CONFIGURATION_FILES, DATABASE_REVISION, DIRECT_READING, LAST_RESTORE_TIME, MAINTENANCE_REQUIRED, MEMBER_OF, MODE, OPERATION_EXPECTED, SETTING, SILENCED, TRACKING_VALUE, ZONE_MEMBERS, LIFE_SAFETY_ALARM_VALUES, MAX_SEGMENTS_ACCEPTED, PROFILE_NAME, AUTO_SLAVE_DISCOVERY, MANUAL_SLAVE_ADDRESS_BINDING, SLAVE_ADDRESS_BINDING, SLAVE_PROXY_ENABLE, LAST_NOTIFY_RECORD, SCHEDULE_DEFAULT, ACCEPTED_MODES, ADJUST_VALUE, COUNT, COUNT_BEFORE_CHANGE, COUNT_CHANGE_TIME, COV_PERIOD, INPUT_REFERENCE, LIMIT_MONITORING_INTERVAL, LOGGING_OBJECT, LOGGING_RECORD, PRESCALE, PULSE_RATE, SCALE, SCALE_FACTOR, UPDATE_TIME, VALUE_BEFORE_CHANGE, VALUE_SET, VALUE_CHANGE_TIME, ALIGN_INTERVALS, INTERVAL_OFFSET, LAST_RESTART_REASON, LOGGING_TYPE, RESTART_NOTIFICATION_RECIPIENTS, TIME_OF_DEVICE_RESTART, TIME_SYNCHRONIZATION_INTERVAL, TRIGGER, UTC_TIME_SYNCHRONIZATION_RECIPIENTS, NODE_SUBTYPE, NODE_TYPE, STRUCTURED_OBJECT_LIST, SUBORDINATE_ANNOTATIONS, SUBORDINATE_LIST, ACTUAL_SHED_LEVEL, DUTY_WINDOW, EXPECTED_SHED_LEVEL, FULL_DUTY_BASELINE, REQUESTED_SHED_LEVEL, SHED_DURATION, SHED_LEVEL_DESCRIPTIONS, SHED_LEVELS, STATE_DESCRIPTION, DOOR_ALARM_STATE, DOOR_EXTENDED_PULSE_TIME, DOOR_MEMBERS, DOOR_OPEN_TOO_LONG_TIME, DOOR_PULSE_TIME, DOOR_STATUS, DOOR_UNLOCK_DELAY_TIME, LOCK_STATUS, MASKED_ALARM_VALUES, SECURED_STATUS, ABSENTEE_LIMIT, ACCESS_ALARM_EVENTS, ACCESS_DOORS, ACCESS_EVENT, ACCESS_EVENT_AUTHENTICATION_FACTOR, ACCESS_EVENT_CREDENTIAL, ACCESS_EVENT_TIME, ACCESS_TRANSACTION_EVENTS, ACCOMPANIMENT, ACCOMPANIMENT_TIME, ACTIVATION_TIME, ACTIVE_AUTHENTICATION_POLICY, ASSIGNED_ACCESS_RIGHTS, AUTHENTICATION_FACTORS, AUTHENTICATION_POLICY_LIST, AUTHENTICATION_POLICY_NAMES, AUTHENTICATION_STATUS, AUTHORIZATION_MODE, BELONGS_TO, CREDENTIAL_DISABLE, CREDENTIAL_STATUS, CREDENTIALS, CREDENTIALS_IN_ZONE, DAYS_REMAINING, ENTRY_POINTS, EXIT_POINTS, EXPIRATION_TIME, EXTENDED_TIME_ENABLE, FAILED_ATTEMPT_EVENTS, FAILED_ATTEMPTS, FAILED_ATTEMPTS_TIME, LAST_ACCESS_EVENT, LAST_ACCESS_POINT, LAST_CREDENTIAL_ADDED, LAST_CREDENTIAL_ADDED_TIME, LAST_CREDENTIAL_REMOVED, LAST_CREDENTIAL_REMOVED_TIME, LAST_USE_TIME, LOCKOUT, LOCKOUT_RELINQUISH_TIME, MAX_FAILED_ATTEMPTS, MEMBERS, MUSTER_POINT, NEGATIVE_ACCESS_RULES, NUMBER_OF_AUTHENTICATION_POLICIES, OCCUPANCY_COUNT, OCCUPANCY_COUNT_ADJUST, OCCUPANCY_COUNT_ENABLE, OCCUPANCY_LOWER_LIMIT, OCCUPANCY_LOWER_LIMIT_ENFORCED, OCCUPANCY_STATE, OCCUPANCY_UPPER_LIMIT, OCCUPANCY_UPPER_LIMIT_ENFORCED, PASSBACK_MODE, PASSBACK_TIMEOUT, POSITIVE_ACCESS_RULES, REASON_FOR_DISABLE, SUPPORTED_FORMATS, SUPPORTED_FORMAT_CLASSES, THREAT_AUTHORITY, THREAT_LEVEL, TRACE_FLAG, TRANSACTION_NOTIFICATION_CLASS, USER_EXTERNAL_IDENTIFIER, USER_INFORMATION_REFERENCE, USER_NAME, USER_TYPE, USES_REMAINING, ZONE_FROM, ZONE_TO, ACCESS_EVENT_TAG, GLOBAL_IDENTIFIER, VERIFICATION_TIME, BASE_DEVICE_SECURITY_POLICY, DISTRIBUTION_KEY_REVISION, DO_NOT_HIDE, KEY_SETS, LAST_KEY_SERVER, NETWORK_ACCESS_SECURITY_POLICIES, PACKET_REORDER_TIME, SECURITY_PDU_TIMEOUT, SECURITY_TIME_WINDOW, SUPPORTED_SECURITY_ALGORITHMS, UPDATE_KEY_SET_TIMEOUT, BACKUP_AND_RESTORE_STATE, BACKUP_PREPARATION_TIME, RESTORE_COMPLETION_TIME, RESTORE_PREPARATION_TIME, BIT_MASK, BIT_TEXT, IS_UTC, GROUP_MEMBERS, GROUP_MEMBER_NAMES, MEMBER_STATUS_FLAGS, REQUESTED_UPDATE_INTERVAL, COVU_PERIOD, COVU_RECIPIENTS, EVENT_MESSAGE_TEXTS, EVENT_MESSAGE_TEXTS_CONFIG, EVENT_DETECTION_ENABLE, EVENT_ALGORITHM_INHIBIT, EVENT_ALGORITHM_INHIBIT_REF, TIME_DELAY_NORMAL, RELIABILITY_EVALUATION_INHIBIT, FAULT_PARAMETERS, FAULT_TYPE, LOCAL_FORWARDING_ONLY, PROCESS_IDENTIFIER_FILTER, SUBSCRIBED_RECIPIENTS, PORT_FILTER, AUTHORIZATION_EXEMPTIONS, ALLOW_GROUP_DELAY_INHIBIT, CHANNEL_NUMBER, CONTROL_GROUPS, EXECUTION_DELAY, LAST_PRIORITY, WRITE_STATUS, PROPERTY_LIST, SERIAL_NUMBER, BLINK_WARN_ENABLE, DEFAULT_FADE_TIME, DEFAULT_RAMP_RATE, DEFAULT_STEP_INCREMENT, EGRESS_TIME, IN_PROGRESS, INSTANTANEOUS_POWER, LIGHTING_COMMAND, LIGHTING_COMMAND_DEFAULT_PRIORITY, MAX_ACTUAL_VALUE, MIN_ACTUAL_VALUE, POWER, TRANSITION, EGRESS_ACTIVE, INTERFACE_VALUE, FAULT_HIGH_LIMIT, FAULT_LOW_LIMIT, LOW_DIFF_LIMIT, STRIKE_COUNT, TIME_OF_STRIKE_COUNT_RESET, DEFAULT_TIMEOUT, INITIAL_TIMEOUT, LAST_STATE_CHANGE, STATE_CHANGE_VALUES, TIMER_RUNNING, TIMER_STATE, APDU_LENGTH, IP_ADDRESS, IP_DEFAULT_GATEWAY, IP_DHCP_ENABLE, IP_DHCP_LEASE_TIME, IP_DHCP_LEASE_TIME_REMAINING, IP_DHCP_SERVER, IP_DNS_SERVER, BACNET_IP_GLOBAL_ADDRESS, BACNET_IP_MODE, BACNET_IP_MULTICAST_ADDRESS, BACNET_IP_NAT_TRAVERSAL, IP_SUBNET_MASK, BACNET_IP_UDP_PORT, BBMD_ACCEPT_FD_REGISTRATIONS, BBMD_BROADCAST_DISTRIBUTION_TABLE, BBMD_FOREIGN_DEVICE_TABLE, CHANGES_PENDING, COMMAND, FD_BBMD_ADDRESS, FD_SUBSCRIPTION_LIFETIME, LINK_SPEED, LINK_SPEEDS, LINK_SPEED_AUTONEGOTIATE, MAC_ADDRESS, NETWORK_INTERFACE_NAME, NETWORK_NUMBER, NETWORK_NUMBER_QUALITY, NETWORK_TYPE, ROUTING_TABLE, VIRTUAL_MAC_ADDRESS_TABLE, COMMAND_TIME_ARRAY, CURRENT_COMMAND_PRIORITY, LAST_COMMAND_TIME, VALUE_SOURCE, VALUE_SOURCE_ARRAY, BACNET_IPV6_MODE, IPV6_ADDRESS, IPV6_PREFIX_LENGTH, BACNET_IPV6_UDP_PORT, IPV6_DEFAULT_GATEWAY, BACNET_IPV6_MULTICAST_ADDRESS, IPV6_DNS_SERVER, IPV6_AUTO_ADDRESSING_ENABLE, IPV6_DHCP_LEASE_TIME, IPV6_DHCP_LEASE_TIME_REMAINING, IPV6_DHCP_SERVER, IPV6_ZONE_INDEX, ASSIGNED_LANDING_CALLS, CAR_ASSIGNED_DIRECTION, CAR_DOOR_COMMAND, CAR_DOOR_STATUS, CAR_DOOR_TEXT, CAR_DOOR_ZONE, CAR_DRIVE_STATUS, CAR_LOAD, CAR_LOAD_UNITS, CAR_MODE, CAR_MOVING_DIRECTION, CAR_POSITION, ELEVATOR_GROUP, ENERGY_METER, ENERGY_METER_REF, ESCALATOR_MODE, FAULT_SIGNALS, FLOOR_TEXT, GROUP_ID, GROUP_MODE, HIGHER_DECK, INSTALLATION_ID, LANDING_CALLS, LANDING_CALL_CONTROL, LANDING_DOOR_STATUS, LOWER_DECK, MACHINE_ROOM_ID, MAKING_CAR_CALL, NEXT_STOPPING_FLOOR, OPERATION_DIRECTION, PASSENGER_ALARM, POWER_MODE, REGISTERED_CAR_CALL, ACTIVE_COV_MULTIPLE_SUBSCRIPTIONS, PROTOCOL_LEVEL, REFERENCE_PORT, DEPLOYED_PROFILE_LOCATION, PROFILE_LOCATION, TAGS, SUBORDINATE_NODE_TYPES, SUBORDINATE_TAGS, SUBORDINATE_RELATIONSHIPS, DEFAULT_SUBORDINATE_RELATIONSHIP, REPRESENTS
		additionalProperties	False
parameter	The parameter of the subscription like the transition to react on and when to react. Default value is [{“bacnetTransitions”:[“TO_OFF_NORMAL”,”TO_FAULT”,”TO_NORMAL”],”confirmedDelivery”:true,”days”:[“MONDAY”,”TUESDAY”,”WEDNESDAY”,”THURSDAY”,”FRIDAY”,”SATURDAY”,”SUNDAY”],”fromTime”:{“hour”:0,”hundredth”:0,”minute”:0,”second”:0},”toTime”:{“hour”:23,”hundredth”:99,”minute”:59,”second”:59}}]
	default	bacnetTransitions	TO_OFF_NORMAL
			TO_FAULT
			TO_NORMAL
		confirmedDelivery	True
		days	MONDAY
			TUESDAY
			WEDNESDAY
			THURSDAY
			FRIDAY
			SATURDAY
			SUNDAY
		fromTime	hour	0
			hundredth	0
			minute	0
			second	0
		toTime	hour	23
			hundredth	99
			minute	59
			second	59
	SubscriptionParameter
processIdentifier	The identifier of the notification class to subscribe on. This identifier is unique if (deviceId + Notification instance + processIdentifier) are unique.
	type	integer
templateId	The id of the template to use for this file
	type	string
templateVariables	The variables and their values to be replaced from the template
	type	object
	additionalProperties
variablesFiles	The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.
	type	array
	items	type	string
additionalProperties	False

LinkedActionConfigurationEntity

type	object
properties
actionId	The itemId of the action.ospp to execute
	type	string
expiration	The duration after which the action will be timed out
	DurationConfigurationEntity
moduleId	The module that will execute the action, this can be used for example if the action is a ping who can be executed by multiples instance of osp-network-monitor
	type	string
parameters	The parameters are allowing to choice the parameters who will be sent to the action. Each action required different parameters base on the type.
	type	object
	additionalProperties	oneOf	CONSTANT
			LIST
			PROPERTIES
			FIELD
additionalProperties	False

DurationConfigurationEntity

type	object
properties
unit	The unit of time expressed
	type	string
	enum	NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS
value	The amount of time expressed with the unit
	type	integer
additionalProperties	False

CONSTANT

type	object
properties
type	type	string
	enum	CONSTANT
	default	CONSTANT
value	A constant value
additionalProperties	False

LIST

type	object
properties
type	type	string
	enum	LIST
	default	LIST
values	A list of value accessors
	type	array
	items	oneOf	CONSTANT
			LIST
			PROPERTIES
			FIELD
additionalProperties	False

PROPERTIES

type	object
properties
type	type	string
	enum	PROPERTIES
	default	PROPERTIES
properties	An object of value accessors
	type	object
	additionalProperties	oneOf	CONSTANT
			LIST
			PROPERTIES
			FIELD
additionalProperties	False

FIELD

type	object
properties
type	type	string
	enum	FIELD
	default	FIELD
field	A field of the value
	type	string
	enum	ID, CONTENT, ERROR, TYPE, TIMESTAMP, NAME, DESCRIPTION
fieldParser	An expression to access a field of the JSON content of the value
	type	string
additionalProperties	False

PropertiesEntity

type	object
properties
range	type	string
additionalProperties	False

SubscriptionParameter

type	object
properties
bacnetTransitions	In BACnet systems, object can transition between different states, such as “offnormal”, “fault”, and “normal”. This parameter allows you to specify which bacnetTransitions should trigger a LinkedAction. Warning This parameter is on the client side, meaning that the BACnet device must support and be configured for Intrinsic Reporting for the notifications to work as expected. Learn more about BACNET ↗️. Default value is [[“TO_OFF_NORMAL”,”TO_FAULT”,”TO_NORMAL”]]
	type	array
	default	TO_OFF_NORMAL
		TO_FAULT
		TO_NORMAL
	items	type	string
		enum	TO_OFF_NORMAL, TO_FAULT, TO_NORMAL
confirmedDelivery	Define if the notification must use confirmation for the message transmission. Learn more about BACNET ↗️. Default value is [true]
	type	boolean
	default	True
days	Define which days of the week the notification should be triggered. Learn more about BACNET ↗️. Default value is [[“MONDAY”,”TUESDAY”,”WEDNESDAY”,”THURSDAY”,”FRIDAY”,”SATURDAY”,”SUNDAY”]]
	type	array
	default	MONDAY
		TUESDAY
		WEDNESDAY
		THURSDAY
		FRIDAY
		SATURDAY
		SUNDAY
	items	type	string
		enum	MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
fromTime	Define the moment of the day when the notification should start being triggered. Learn more about BACNET ↗️. Default value is [{“hour”:0,”hundredth”:0,”minute”:0,”second”:0}]
	default	hour	0
		hundredth	0
		minute	0
		second	0
	Time
toTime	Define the moment of the day when the notification should stop being triggered. Learn more about BACNET ↗️. Default value is [{“hour”:23,”hundredth”:99,”minute”:59,”second”:59}]
	default	hour	23
		hundredth	99
		minute	59
		second	59
	Time
additionalProperties	False

Time

type	object
properties
hour	An hour of the day.
	type	integer
	maximum	23
	minimum	0
hundredth	An hundredth of the second.
	type	integer
	maximum	99
	minimum	0
minute	An minute of the hour.
	type	integer
	maximum	59
	minimum	0
second	An second of the minute.
	type	integer
	maximum	59
	minimum	0
additionalProperties	False