Skip to content
Chipkin
Version 6.1.0
Documentation
Profiles
Compare
Changelog
Contact Us
Menu
Getting started
BACnet in ten minutes
Quick Start
Configuring a build
Configuring a build: targets and profiles
Using the stack
Stack lifecycle
Serving property values
Acting as a client
COV, alarms and events, and trend logs
Data links
Data links overview
BACnet/IP
Overview
Sending and receiving
Network Port object
Practical notes
BACnet MS/TP
Overview
Byte and packet mode
Network Port and settings
Practical notes
Moving from MSTP.c
BACnet/SC
Overview
Integration guide
Certificates
Transport callbacks
Operations and troubleshooting
Moving from BACnet/IP
Reference
Guides
Debug logging
Network Port objects
ReinitializeDevice
BBMD and foreign devices
Virtual devices and gateways
Device Communication Control
Object types
All object types
Access Credential
Access Door
Access Point
Access Rights
Access User
Access Zone
Accumulator
Alert Enrollment
Analog Input
Analog Output
Analog Value
Audit Log
Audit Reporter
Averaging
Binary Input
Binary Lighting Output
Binary Output
Binary Value
BitString Value
Calendar
Channel
CharacterString Value
Color
Color Temperature
Command
Credential Data Input
Date Pattern Value
Date Value
DateTime Pattern Value
DateTime Value
Device
Elevator Group
Escalator
Event Enrollment
Event Log
File
Global Group
Group
Integer Value
Large Analog Value
Life Safety Point
Life Safety Zone
Lift
Lighting Output
Load Control
Loop
Multi-state Input
Multi-state Output
Multi-state Value
Network Port
Notification Class
Notification Forwarder
OctetString Value
Positive Integer Value
Program
Pulse Converter
Schedule
Staging
Structured View
Time Pattern Value
Time Value
Timer
Trend Log
Trend Log Multiple
API Reference
Overview
API conventions
Version, information and settings
Overview
BACnetStack_GetAPIMajorVersion
BACnetStack_GetAPIMinorVersion
BACnetStack_GetAPIPatchVersion
BACnetStack_GetAPIBuildVersion
BACnetStack_GetBACnetProtocolRevision
BACnetStack_GetInfo
BACnetStack_GetInfoLength
BACnetStack_SetBACnetStackSetting
BACnetStack_GetBACnetStackSetting
Main loop and reset
Overview
BACnetStack_Tick
BACnetStack_Reset
Device and services
Overview
BACnetStack_AddDevice
BACnetStack_RemoveDevice
BACnetStack_UpdateDeviceInstance
BACnetStack_SetServiceEnabled
BACnetStack_SetSegmentationEnabled
BACnetStack_SetCOVSettings
BACnetStack_SetMaxActiveCOVSubscriptions
BACnetStack_SetMaxSupportedCOVLifetime
BACnetStack_SetCOVMultipleSettings
BACnetStack_SetBackupAndRestoreEnabled
Objects and properties
Overview
BACnetStack_AddObject
BACnetStack_AddNetworkPortObject
BACnetStack_ActivateNetworkPortPendingChanges
BACnetStack_AddTrendLogObject
BACnetStack_AddTrendLogMultipleObject
BACnetStack_AddElevatorGroupObject
BACnetStack_AddLiftOrEscalatorObject
BACnetStack_AddFileObject
BACnetStack_SetPropertyEnabled
BACnetStack_SetPropertyByObjectTypeEnabled
BACnetStack_SetProprietaryProperty
BACnetStack_SetPropertyWritable
BACnetStack_SetPropertyByObjectTypeWritable
BACnetStack_SetPropertySubscribable
BACnetStack_SetPropertyByObjectTypeSubscribable
BACnetStack_SetObjectTypeCreatable
BACnetStack_RemoveObject
BACnetStack_ObjectExists
BACnetStack_AddEventLogObject
BACnetStack_UpdateValue
Schedules, calendars, trend logs and other object configuration
Overview
BACnetStack_SetTrendLogTypeToPolled
BACnetStack_SetTrendLogTypeToCOV
BACnetStack_SetTrendLogTypeToTriggered
BACnetStack_SetTrendLogStartStopTime
BACnetStack_AddLoggedObjectToTrendLogMultiple
BACnetStack_SetLiftHigherLowerDeck
BACnetStack_SetLiftOrEscalatorEnergyMeterRef
BACnetStack_AddChannelObject
BACnetStack_AddObjectPropertyReferenceToChannel
BACnetStack_AddGroupObject
BACnetStack_AddGroupMember
BACnetStack_RemoveGroupMember
BACnetStack_AddScheduleObject
BACnetStack_AddScheduleWeeklyTimeValue
BACnetStack_SetScheduleDefault
BACnetStack_AddScheduleExceptionEventWithCalendarEntry
BACnetStack_AddScheduleExceptionEventWithCalendarReference
BACnetStack_AddCalendarObject
BACnetStack_AddCalendarDateEntry
BACnetStack_AddCalendarDateRangeEntry
BACnetStack_AddCalendarWeekNDayEntry
BACnetStack_ClearCalendarDateList
BACnetStack_AddScheduleExceptionTimeValue
BACnetStack_SetScheduleEffectivePeriod
BACnetStack_AddScheduleObjectPropertyReference
BACnetStack_SetSchedulePriorityForWriting
BACnetStack_InsertTrendLogRecord
BACnetStack_ReadTrendLogRecord
BACnetStack_InsertTrendLogMultipleRecord
BACnetStack_ReadTrendLogMultipleRecord
Alarms and events
Overview
BACnetStack_AddNotificationClassObject
BACnetStack_AddRecipientToNotificationClass
BACnetStack_SetAlarmsAndEventsForObjectEnabled
BACnetStack_SetIntrinsicOutOfRangeAlgorithm
BACnetStack_SetIntrinsicSignedOutOfRangeAlgorithm
BACnetStack_SetIntrinsicUnsignedOutOfRangeAlgorithm
BACnetStack_SetIntrinsicDoubleOutOfRangeAlgorithm
BACnetStack_SetIntrinsicFloatingLimitAlgorithm
BACnetStack_SetIntrinsicUnsignedRangeAlgorithm
BACnetStack_SetIntrinsicBufferReadyAlgorithm
BACnetStack_SetIntrinsicChangeOfStateAlgorithmBool
BACnetStack_SetIntrinsicChangeOfStateAlgorithmEnum
BACnetStack_SetIntrinsicChangeOfStateAlgorithmUnsigned
BACnetStack_SetIntrinsicChangeOfLifeSafetyAlgorithm
BACnetStack_SetIntrinsicChangeOfStatusFlagsAlgorithm
BACnetStack_SetIntrinsicChangeOfBitstringAlgorithm
BACnetStack_SetIntrinsicChangeOfBitstringAlgorithm64
BACnetStack_SetIntrinsicChangeOfCharacterstringAlgorithm
BACnetStack_SetIntrinsicChangeOfDiscreteValueAlgorithm
BACnetStack_SetIntrinsicCommandFailureAlgorithm
BACnetStack_SetIntrinsicChangeOfValueAlgorithm
BACnetStack_SetIntrinsicChangeOfTimerAlgorithm
BACnetStack_SetFaultOutOfRangeAlgorithmReal
BACnetStack_SetFaultListedAlgorithm
BACnetStack_SetFaultLifeSafetyAlgorithm
BACnetStack_SetFaultStatusFlagsAlgorithm
Data link and system callbacks
Overview
BACnetStack_RegisterCallbackReceiveMessageForPort
BACnetStack_RegisterCallbackSendMessageForPort
BACnetStack_RegisterCallbackMSTPReceiveBytes
BACnetStack_RegisterCallbackMSTPSendBytes
BACnetStack_RegisterCallbackMSTPMicroseconds
BACnetStack_RegisterCallbackMSTPTransmitEnable
BACnetStack_RegisterCallbackMSTPFrameHeader
BACnetStack_ReportMSTPReceiveError
BACnetStack_LoopMSTP
BACnetStack_GetMSTPCounters
BACnetStack_RegisterCallbackGetSystemTime
BACnetStack_RegisterCallbackSetSystemTime
BACnetStack_RegisterCallbackLogDebugMessage
Property value callbacks
Overview
BACnetStack_RegisterCallbackGetPropertyBitString
BACnetStack_RegisterCallbackGetPropertyBool
BACnetStack_RegisterCallbackGetPropertyCharacterString
BACnetStack_RegisterCallbackGetPropertyDate
BACnetStack_RegisterCallbackGetPropertyDouble
BACnetStack_RegisterCallbackGetPropertyEnumerated
BACnetStack_RegisterCallbackGetPropertyOctetString
BACnetStack_RegisterCallbackGetPropertySignedInteger
BACnetStack_RegisterCallbackGetPropertyReal
BACnetStack_RegisterCallbackGetPropertyTime
BACnetStack_RegisterCallbackGetPropertyUnsignedInteger
BACnetStack_RegisterCallbackGetPropertyObjectIdentifier
BACnetStack_RegisterCallbackGetPropertyLightingCommand
BACnetStack_RegisterCallbackGetPropertyAuthenticationFactorFormat
BACnetStack_RegisterCallbackGetListOfEnumerations
BACnetStack_RegisterCallbackGetListElevatorGroupLandingCallStatus
BACnetStack_RegisterCallbackGetSequenceLiftRegisteredCarCall
BACnetStack_RegisterCallbackGetSequenceLiftAssignedLandingCall
BACnetStack_RegisterCallbackGetSequenceLiftLandingDoorStatus
BACnetStack_RegisterCallbackSetPropertyBitString
BACnetStack_RegisterCallbackSetPropertyBool
BACnetStack_RegisterCallbackSetPropertyCharacterString
BACnetStack_RegisterCallbackSetPropertyDate
BACnetStack_RegisterCallbackSetPropertyDouble
BACnetStack_RegisterCallbackSetPropertyEnumerated
BACnetStack_RegisterCallbackSetPropertyNull
BACnetStack_RegisterCallbackSetPropertyOctetString
BACnetStack_RegisterCallbackSetPropertySignedInteger
BACnetStack_RegisterCallbackSetPropertyReal
BACnetStack_RegisterCallbackSetPropertyTime
BACnetStack_RegisterCallbackSetPropertyUnsignedInteger
BACnetStack_RegisterCallbackSetPropertyObjectIdentifier
BACnetStack_RegisterCallbackSetElevatorGroupLandingCallControl
BACnetStack_RegisterCallbackSetPropertyLightingCommand
Service callbacks
Overview
BACnetStack_RegisterCallbackWriteGroupInhibitDelay
BACnetStack_RegisterCallbackCreateObject
BACnetStack_RegisterCallbackDeleteObject
BACnetStack_RegisterCallbackReinitializeDevice
BACnetStack_RegisterCallbackNetworkPortCommand
BACnetStack_RegisterCallbackValidateNetworkPortChanges
BACnetStack_RegisterCallbackDeviceCommunicationControl
BACnetStack_RegisterCallbackLifeSafetyOperation
BACnetStack_RegisterCallbackAcknowledgeAlarm
BACnetStack_RegisterCallbackEventNotificationReceived
BACnetStack_RegisterCallbackReadFile
BACnetStack_RegisterCallbackWriteFile
BACnetStack_RegisterCallbackReadFileRecord
BACnetStack_RegisterCallbackWriteFileRecord
BACnetStack_RegisterCallbackPrepareBackup
BACnetStack_RegisterCallbackCompleteBackup
BACnetStack_RegisterCallbackPrepareRestore
BACnetStack_RegisterCallbackCompleteRestore
BACnetStack_RegisterHookTextMessage
Client requests
Overview
BACnetStack_DecodeAs
BACnetStack_SendSubscribeCOV
BACnetStack_SendCancelSubscribeCOV
BACnetStack_SendSubscribeCOVProperty
BACnetStack_SendCancelSubscribeCOVProperty
BACnetStack_SendUnsubscribedUnconfirmedCOVNotification
BACnetStack_SendAtomicReadFile
BACnetStack_SendAtomicWriteFile
BACnetStack_SendReadProperty
BACnetStack_SendReadPropertyWithLength
BACnetStack_SendWriteProperty
BACnetStack_SendCreateObject
BACnetStack_SendDeleteObject
BACnetStack_SendReadRange
BACnetStack_SendReadRangeWithPosition
BACnetStack_SendReadRangeWithSequenceNumber
BACnetStack_SendReadRangeWithTime
BACnetStack_SendIAm
BACnetStack_SendWhoAmI
BACnetStack_SendYouAre
BACnetStack_SendWhoIs
BACnetStack_SendWhoIsWithLimits
BACnetStack_SendWhoHasWithObjectIdentifier
BACnetStack_SendWhoHasWithObjectName
BACnetStack_SendWhoHasWithObjectIdentifierAndLimits
BACnetStack_SendWhoHasWithObjectNameAndLimits
BACnetStack_SendTimeSynchronization
BACnetStack_SendUTCTimeSynchronization
BACnetStack_SendReinitializeDevice
BACnetStack_SendDeviceCommunicationControl
BACnetStack_SendLifeSafetyOperation
BACnetStack_SendConfirmedTextMessage
BACnetStack_SendUnconfirmedTextMessage
BACnetStack_SendGetEventInformation
BACnetStack_SendAcknowledgeAlarmDateTime
BACnetStack_SendAcknowledgeAlarmUnsigned
BACnetStack_SendAcknowledgeAlarmTime
BACnetStack_SendWriteGroup
BACnetStack_SendSubscribeCOVPropertyMultiple
Client response hooks
Overview
BACnetStack_RegisterHookIAm
BACnetStack_RegisterHookIHave
BACnetStack_RegisterHookError
BACnetStack_RegisterHookReject
BACnetStack_RegisterHookAbort
BACnetStack_RegisterHookSimpleAck
BACnetStack_RegisterHookTimeout
BACnet/IP: BBMD and foreign devices
Overview
BACnetStack_SendRegisterForeignDevice
BACnetStack_SendReadBroadcastDistributionTable
BACnetStack_SendReadForeignDeviceTable
BACnetStack_SetBBMD
BACnetStack_GetBDTEntry
BACnetStack_GetFDTEntry
BACnetStack_AddBDTEntry
BACnetStack_DeleteBDTEntry
BACnetStack_DeleteFDTEntry
BACnetStack_ResetForeignDeviceTable
BACnetStack_ResetBroadcastDistributionTable
Routing and virtual networks
Overview
BACnetStack_AddVirtualNetwork
BACnetStack_AddRouterPort
BACnetStack_AddRouterRoute
BACnetStack_SetRouterEnabled
BACnetStack_AddDeviceToVirtualNetwork
BACnetStack_UpdateVirtualNetworkNumber
BACnetStack_SendIAmRouterToNetwork
BACnetStack_SendWhoIsRouterToNetwork
BACnetStack_SendNetworkNumberIs
BACnet/SC
Overview
BACnetStack_SetBACnetSCUuid
BACnetStack_SetBACnetSCHubConnector
BACnetStack_SetBACnetSCHubConnectorForNetworkPort
BACnetStack_SetBACnetSCSettings
BACnetStack_SetBACnetSCHelloCapabilities
BACnetStack_SetBACnetSCCompatibilityFlags
BACnetStack_SetBACnetSCHubFunctionConfig
BACnetStack_SetBACnetSCDirectConnectConfig
BACnetStack_AddBACnetSCAcceptUri
BACnetStack_ClearBACnetSCAcceptUris
BACnetStack_SetBACnetSCCertificateFileObjects
BACnetStack_SetBACnetSCWebSocketStatus
BACnetStack_RegisterCallbackInitiateWebsocket
BACnetStack_RegisterCallbackDisconnectWebsocket
BACnetStack_RegisterCallbackSCStartListening
BACnetStack_RegisterCallbackSCStopListening
BACnetStack_RegisterCallbackBACnetSCStateChange
BACnetStack_SCCertificateAddIssuer
BACnetStack_SCCertificateReplaceOperational
BACnetStack_SCCertificateRemoveIssuer
BACnetStack_SCCertificateProvideSignedCertificate
BACnetStack_SCCertificateCancel
BACnetStack_RegisterCallbackSCCertificateSignRequest
BACnetStack_RegisterHookSCCertificateProcedure
Callback types
Constants and types
Enumerations
All enumerations
BACnetAbortReason
BACnetAccessAuthenticationFactorDisable
BACnetAccessCredentialDisable
BACnetAccessCredentialDisableReason
BACnetAccessEvent
BACnetAccessPassbackMode
BACnetAccessUserType
BACnetAccessZoneOccupancyState
BACnetAcknowledgementFilter
BACnetAction
BACnetAuditLevel
BACnetAuditOperation
BACnetAuditOperationFlags
BACnetAuditPriorityFilter
BACnetAuthenticationDecision
BACnetAuthenticationFactorType
BACnetAuthenticationStatus
BACnetAuthorizationDecision
BACnetAuthorizationExemption
BACnetAuthorizationMode
BACnetAuthorizationPosture
BACnetBackupState
BACnetBinaryLightingPV
BACnetBinaryPV
BACnetColorOperation
BACnetColorOperationInProgress
BACnetColorTransition
BACnetConfirmedServiceChoice
BACnetDaysOfWeek
BACnetDeviceStatus
BACnetDoorAlarmState
BACnetDoorSecuredStatus
BACnetDoorStatus
BACnetDoorValue
BACnetEnableDisable
BACnetEngineeringUnits
BACnetErrorClass
BACnetErrorCode
BACnetEscalatorFault
BACnetEscalatorMode
BACnetEscalatorOperationDirection
BACnetEventState
BACnetEventStateFilter
BACnetEventTransitionBits
BACnetEventType
BACnetFaultType
BACnetFileAccessMethod
BACnetIPMode
BACnetLifeSafetyMode
BACnetLifeSafetyOperation
BACnetLifeSafetyState
BACnetLiftCarDirection
BACnetLiftCarDoorCommand
BACnetLiftCarDriveStatus
BACnetLiftCarMode
BACnetLiftFault
BACnetLiftGroupMode
BACnetLightingInProgress
BACnetLightingOperation
BACnetLightingTransition
BACnetLimitEnable
BACnetLockStatus
BACnetLoggingType
BACnetLogStatus
BACnetMaintenance
BACnetMessagePriority
BACnetNetworkNumberQuality
BACnetNetworkPortCommand
BACnetNetworkType
BACnetNodeType
BACnetNotifyType
BACnetObjectType
BACnetPolarity
BACnetPriorityFilterBitString
BACnetProgramError
BACnetProgramRequest
BACnetProgramState
BACnetPropertyIdentifier
BACnetProtocolLevel
BACnetReinitializedStateOfDevice
BACnetRejectReason
BACnetRelationship
BACnetReliability
BACnetRestartReason
BACnetResultFlags
BACnetSCConnectionState
BACnetSCHubConnectorState
BACnetSecurityLevel
BACnetSecurityPolicy
BACnetSegmentation
BACnetServicesSupported
BACnetShedState
BACnetSilencedState
BACnetStackDatatypes
BACnetStatusFlags
BACnetSuccessFilter
BACnetTag
BACnetTimerState
BACnetTimerTransition
BACnetUnconfirmedServiceChoice
BACnetVTClass
BACnetWriteStatus
Reference
Glossary
Changelog
Decoded output reference (XML and JSON)
Upgrading from version 5
Upgrade guide
Decoded XML and JSON output
BACnetSuccessFilter
The
BACnetSuccessFilter
enumeration: 3 values.
Name
Value
Note
all
0
successesOnly
1
failuresOnly
2
