BACnet type adapter

BACnet adapter table

Adapter name	Write from value type Text	Read from value type Text
ACCESS_RULE		see details
ACCUMULATED_RECORD		see details
ADDRESS	see details	see details
ADDRESS_BINDING	see details	see details
ASSIGNED_LAND_CALLS		see details
BACNET_ERROR
BINARY_PV
BIT_STRING	see details
BOOLEAN
CHANGE_LIST
CHANNEL_VALUE_BIT_STRING	see details
CHANNEL_VALUE_BOOLEAN
CHANNEL_VALUE_CHARACTER_STRING	see details
CHANNEL_VALUE_DATE
CHANNEL_VALUE_DOUBLE
CHANNEL_VALUE_NULL
CHANNEL_VALUE_OCTET_STRING
CHANNEL_VALUE_REAL
CHANNEL_VALUE_SIGNED_INTEGER
CHANNEL_VALUE_TIME
CHANNEL_VALUE_UNSIGNED_INTEGER
CHARACTER_STRING_ANSI_X34
CHARACTER_STRING_BASE
CHARACTER_STRING_IBM_MS_DBCS
CHARACTER_STRING_ISO10646_UCS2
CHARACTER_STRING_ISO10646_UCS4
CHARACTER_STRING_JIS_C6226
DAILY_SCHEDULE		see details
DATE
DATE_RANGE	see details
DATE_TIME		see details
DAYS_OF_WEEK		see details
DESTINATION		see details
DEVICE_OBJECT_PROPERTY_REFERENCE		see details
DEVICE_OBJECT_PROPERTY_VALUE		see details
DEVICE_OBJECT_REFERENCE	see details	see details
DOUBLE
ENCODED_VALUE		see details
ERROR_CLASS_AND_CODE
EVENT_TRANSITION_BITS
HOST_ADDRESS		see details
HOST_N_PORT		see details
LIMIT_ENABLE
LOG_STATUS
NULL
OBJECT_IDENTIFIER	see details
OBJECT_PROPERTY_REFERENCE	see details	see details
OBJECT_TYPES_SUPPORTED
OCTET_STRING
OPTIONAL_BINARY_PV
OPTIONAL_CHARACTER_STRING	see details
OPTIONAL_REAL
OPTIONAL_UNSIGNED
PRESCALE	see details	see details
REAL
RECIPIENT		see details
RECIPIENT_ADDRESS	see details
RECIPIENT_OBJECT_IDENTIFIER	see details
RESULT_FLAGS		see details
SCALE_REAL
SCALE_SIGNED
SERVICES_SUPPORTED
SHED_LEVEL_DATUM	see details
SHED_LEVEL_REAL
SIGNED_INTEGER
STATUS_FLAGS	see details	see details
TIME
TIME_VALUE		see details
TIMESTAMP_DATE_TIME
TIMESTAMP_SEQUENCE
TIMESTAMP_TIME	see details
UNSIGNED_INTEGER
VALUE_SOURCE_ADDRESS	see details
VALUE_SOURCE_DEVICE_OBJECT_REFERENCE	see details
VMAC_ENTRY		see details

BACnet adapter details

Access Rule Adapter Format

type	object
properties
location	#/definitions/DeviceObjectReferenceAdapterFormat
locationSpecifier	type	string
objectReference	#/definitions/DeviceObjectPropertyReferenceAdapterFormat
timeRange	type	string
additionalProperties	False
definitions
DeviceObjectReferenceAdapterFormat	type	object
	properties
	deviceReference	#/definitions/ObjectIdentifierAdapterFormat
	objectReference	#/definitions/ObjectIdentifierAdapterFormat
	additionalProperties	False
ObjectIdentifierAdapterFormat	type	object
	properties
	objectIdentifierInstance	The instance of the object type example 2 for Binary Input 2
		type	integer
	objectIdentifierType	The type of the BACnet object in number format
		type	integer
	additionalProperties	False
DeviceObjectPropertyReferenceAdapterFormat	type	object
	properties
	deviceIdentifier	The identifier of the referenced device
		#/definitions/ObjectIdentifierAdapterFormat
	objectIdentifier	The identifier of the object BACnet referenced
		#/definitions/ObjectIdentifierAdapterFormat
	propertyArrayIndex	The position of the index (in an array)
		type	integer
	propertyIdentifier	The identifier of the property like presentValue or statusFlags in numeric format
		type	integer
	additionalProperties	False

Accumulator Record Adapter Format

type	object
properties
accumulatedValue	type	integer
accumulatorStatus	type	string
dateTime	#/definitions/DateTimeAdapterFormat
presentValue	type	integer
additionalProperties	False
definitions
DateTimeAdapterFormat	type	object
	properties
	date	#/definitions/DateAdapterFormat
	time	#/definitions/TimeAdapterFormat
	additionalProperties	False
DateAdapterFormat	type	object
	properties
	day	The month in numeric format, because the value can be even or odd
		type	integer
	dayOfWeek	The day of the week in string format with possible value like : “MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7), UNSPECIFIED(255)”;
		type	string
	month	The month in string format, because the value can be even or odd
		type	string
	year	The year in numeric format
		type	integer
	additionalProperties	False
TimeAdapterFormat	type	object
	properties
	hour	type	integer
	hundredth	type	integer
	minute	type	integer
	second	type	integer
	additionalProperties	False

Address Adapter Format

type	object
properties
macAddress	type	string
networkNumber	type	integer
additionalProperties	False

Address Binding Adapter Format

type	object
properties
address	#/definitions/AddressAdapterFormat
deviceObjectIdentifier	#/definitions/ObjectIdentifierAdapterFormat
additionalProperties	False
definitions
AddressAdapterFormat	type	object
	properties
	macAddress	type	string
	networkNumber	type	integer
	additionalProperties	False
ObjectIdentifierAdapterFormat	type	object
	properties
	objectIdentifierInstance	The instance of the object type example 2 for Binary Input 2
		type	integer
	objectIdentifierType	The type of the BACnet object in number format
		type	integer
	additionalProperties	False

Assigned Land Calls Adapter Format

type	array
items	#/definitions/LandingCallEntity
definitions
LandingCallEntity	type	object
	properties
	direction	type	string
	floorNumber	type	integer
	additionalProperties	False

Bitstring Adapter Format

type	array
items	type	boolean

Character String Adapter Format

type	object
properties
encoding	The encoding used for the BACnet object or value. The TEXT value is always in UTF-8 format; the specified encoding is only applied when reading from or writing to the device.
	type	string
	enum	ANSI_X3_4, IBM_MS_DBCS, JIS_C_6226, ISO_10646_UCS_4, ISO_10646_UCS_2, ISO_8859_1
text	The text in UTF-8 format
	type	string
additionalProperties	False

Daily Schedule Adapter Format

type	array
items	#/definitions/TimeValueAdapterFormat
definitions
TimeValueAdapterFormat	type	object
	properties
	time	The time value in the format : Integer.toString(hour) + “:” + Integer.toString(minute) + “:” + Integer.toString(second) + “.” + hundredth
		type	string
	value	The value linked to this timeValue, converted in simple form (no json format, or complex adapter is used here).
		type	string
	additionalProperties	False

Date Range Adapter Format

type	object
properties
end	#/definitions/DateAdapterFormat
start	#/definitions/DateAdapterFormat
additionalProperties	False
definitions
DateAdapterFormat	type	object
	properties
	day	The month in numeric format, because the value can be even or odd
		type	integer
	dayOfWeek	The day of the week in string format with possible value like : “MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7), UNSPECIFIED(255)”;
		type	string
	month	The month in string format, because the value can be even or odd
		type	string
	year	The year in numeric format
		type	integer
	additionalProperties	False

Date Time Adapter Format

type	object
properties
date	#/definitions/DateAdapterFormat
time	#/definitions/TimeAdapterFormat
additionalProperties	False
definitions
DateAdapterFormat	type	object
	properties
	day	The month in numeric format, because the value can be even or odd
		type	integer
	dayOfWeek	The day of the week in string format with possible value like : “MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7), UNSPECIFIED(255)”;
		type	string
	month	The month in string format, because the value can be even or odd
		type	string
	year	The year in numeric format
		type	integer
	additionalProperties	False
TimeAdapterFormat	type	object
	properties
	hour	type	integer
	hundredth	type	integer
	minute	type	integer
	second	type	integer
	additionalProperties	False

Days Of Week Adapter Format

type	object
properties
friday	type	boolean
monday	type	boolean
saturday	type	boolean
sunday	type	boolean
thursday	type	boolean
tuesday	type	boolean
wednesday	type	boolean
additionalProperties	False

Destination Adapter Format

type	object
properties
fromTime	#/definitions/TimeAdapterFormat
issueConfirmedNotifications	type	boolean
processIdentifier	type	integer
recipient	#/definitions/RecipientAdapterFormat
toTime	#/definitions/TimeAdapterFormat
transitions	#/definitions/EventTransitionBitFormat
validDays	#/definitions/DaysOfWeekAdapterFormat
additionalProperties	False
definitions
TimeAdapterFormat	type	object
	properties
	hour	type	integer
	hundredth	type	integer
	minute	type	integer
	second	type	integer
	additionalProperties	False
RecipientAdapterFormat	type	object
	properties
	address	#/definitions/AddressAdapterFormat
	device	#/definitions/ObjectIdentifierAdapterFormat
	additionalProperties	False
AddressAdapterFormat	type	object
	properties
	macAddress	type	string
	networkNumber	type	integer
	additionalProperties	False
ObjectIdentifierAdapterFormat	type	object
	properties
	objectIdentifierInstance	The instance of the object type example 2 for Binary Input 2
		type	integer
	objectIdentifierType	The type of the BACnet object in number format
		type	integer
	additionalProperties	False
EventTransitionBitFormat	type	object
	properties
	toFault	Indicates whether a transition to the Fault state shall be reported. Fault represents a condition where the object is unreliable due to an error or malfunction.
		type	boolean
	toNormal	Indicates whether a transition back to the Normal state shall be reported. Normal represents the expected operating condition.
		type	boolean
	toOffnormal	Indicates whether a transition to the OffNormal state shall be reported. OffNormal represents an abnormal condition where the value differs from the expected normal state.
		type	boolean
	additionalProperties	False
DaysOfWeekAdapterFormat	type	object
	properties
	friday	type	boolean
	monday	type	boolean
	saturday	type	boolean
	sunday	type	boolean
	thursday	type	boolean
	tuesday	type	boolean
	wednesday	type	boolean
	additionalProperties	False

Device Object Property Reference Adapter Format

type	object
properties
deviceIdentifier	The identifier of the referenced device
	#/definitions/ObjectIdentifierAdapterFormat
objectIdentifier	The identifier of the object BACnet referenced
	#/definitions/ObjectIdentifierAdapterFormat
propertyArrayIndex	The position of the index (in an array)
	type	integer
propertyIdentifier	The identifier of the property like presentValue or statusFlags in numeric format
	type	integer
additionalProperties	False
definitions
ObjectIdentifierAdapterFormat	type	object
	properties
	objectIdentifierInstance	The instance of the object type example 2 for Binary Input 2
		type	integer
	objectIdentifierType	The type of the BACnet object in number format
		type	integer
	additionalProperties	False

Device Object Property Value Adapter Format

type	object
properties
arrayIndex	type	integer
deviceIdentifier	#/definitions/ObjectIdentifierAdapterFormat
objectIdentifier	#/definitions/ObjectIdentifierAdapterFormat
propertyIdentifier	type	integer
value	type	string
additionalProperties	False
definitions
ObjectIdentifierAdapterFormat	type	object
	properties
	objectIdentifierInstance	The instance of the object type example 2 for Binary Input 2
		type	integer
	objectIdentifierType	The type of the BACnet object in number format
		type	integer
	additionalProperties	False

Device Object Reference Adapter Format

type	object
properties
deviceReference	#/definitions/ObjectIdentifierAdapterFormat
objectReference	#/definitions/ObjectIdentifierAdapterFormat
additionalProperties	False
definitions
ObjectIdentifierAdapterFormat	type	object
	properties
	objectIdentifierInstance	The instance of the object type example 2 for Binary Input 2
		type	integer
	objectIdentifierType	The type of the BACnet object in number format
		type	integer
	additionalProperties	False

Encodable Value Adapter Format

type	array
items	type	integer

Host Address Adapter Format

type	object
properties
hostname	The hostname in IP format or hostname depending of the device configuration
	type	string
additionalProperties	False

Host N Port Adapter Format

type	object
properties
hostname	The hostname in IP format or hostname depending of the device configuration
	type	string
port	The port number
	type	integer
additionalProperties	False

Object Identifier Adapter Format

type	object
properties
objectIdentifierInstance	The instance of the object type example 2 for Binary Input 2
	type	integer
objectIdentifierType	The type of the BACnet object in number format
	type	integer
additionalProperties	False

Object Property Reference Adapter Format

type	object
properties
objectIdentifier	#/definitions/ObjectIdentifierAdapterFormat
propertyIdentifier	type	integer
unsignedArrayIndex	type	integer
additionalProperties	False
definitions
ObjectIdentifierAdapterFormat	type	object
	properties
	objectIdentifierInstance	The instance of the object type example 2 for Binary Input 2
		type	integer
	objectIdentifierType	The type of the BACnet object in number format
		type	integer
	additionalProperties	False

Prescale Adapter Format

type	object
properties
moduloDivide	type	integer
multiplier	type	integer
additionalProperties	False

Recipient Adapter Format

type	object
properties
address	#/definitions/AddressAdapterFormat
device	#/definitions/ObjectIdentifierAdapterFormat
additionalProperties	False
definitions
AddressAdapterFormat	type	object
	properties
	macAddress	type	string
	networkNumber	type	integer
	additionalProperties	False
ObjectIdentifierAdapterFormat	type	object
	properties
	objectIdentifierInstance	The instance of the object type example 2 for Binary Input 2
		type	integer
	objectIdentifierType	The type of the BACnet object in number format
		type	integer
	additionalProperties	False

Result Flags Adapter Format

type	object
properties
firstItem	type	boolean
lastItem	type	boolean
moreItems	type	boolean
additionalProperties	False

Shed Adapter Format

type	object
properties
datum	type	integer
percent	type	boolean
additionalProperties	False

Status Flag Adapter Format

type	object
properties
fault	Indicates whether the device or object has a fault condition.
	type	boolean
inAlarm	Indicates whether the device or object is currently in an alarm state.
	type	boolean
outOfService	Indicates whether the device or object is out of service.
	type	boolean
overridden	Indicates whether the device or object is currently overridden.
	type	boolean
additionalProperties	False

Time Value Adapter Format

type	object
properties
time	The time value in the format : Integer.toString(hour) + “:” + Integer.toString(minute) + “:” + Integer.toString(second) + “.” + hundredth
	type	string
value	The value linked to this timeValue, converted in simple form (no json format, or complex adapter is used here).
	type	string
additionalProperties	False

Timestamp Adapter Format

type	object
properties
timestamp	oneOf	#/definitions/TimestampTime
		#/definitions/TimestampSequenceNumber
		#/definitions/TimestampDateTime
additionalProperties	False
definitions
TimestampTime	TIME
	type	object
	properties
	type	type	string
		enum	TIME
		default	TIME
	hour	type	integer
	hundredth	type	integer
	minute	type	integer
	second	type	integer
	additionalProperties	False
TimestampSequenceNumber	SEQUENCE_NUMBER
	type	object
	properties
	type	type	string
		enum	SEQUENCE_NUMBER
		default	SEQUENCE_NUMBER
	value	type	integer
	additionalProperties	False
TimestampDateTime	DATETIME
	type	object
	properties
	type	type	string
		enum	DATETIME
		default	DATETIME
	day	type	integer
	dayOfWeek	type	integer
	hour	type	integer
	hundredth	type	integer
	minute	type	integer
	month	type	integer
	second	type	integer
	year	type	integer
	additionalProperties	False

Vmac Entry Adapter Format

type	object
properties
nativeMacAddress	type	string
virtualMacAddress	type	string
additionalProperties	False

Unsupported writing types

NameValue
Primitive
Destination
ProcessIdSelection
EventNotificationSubscription
PortPermission
AuthenticationFactor
AuthenticationPolicy
DeviceObjectPropertyReference
PriorityArray
ChannelValue
EventParameter
FaultParameter
LandingCallStatus
SetpointReference
ReadAccessSpecification
ReadAccessResult
AssignedAccessRights
CredentialAuthenticationFactor
NameValueCollection
SecurityKeySet
NetworkSecurityPolicy
AssignedLandingCalls
LandingDoorStatus
AccessRule
AccumulatorRecord
ActionList
BDTEntry
CalendarEntry
ClientCov
CovMultipleSubscription
DailySchedule
LightingCommand
LogMultipleRecord
LogRecord
LiftCarCallList
CovSubscription
VtSession
FDTEntry
HostNPort
RouterEntry
AuthenticationFactorFormat
SpecialEvent
PropertyAccessResult
TimerStateChangeValue
EventLogRecord
VmacEntry
Recipient
Scale