`bacnetExt` 扩展参考

原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793357759/FIN+5.3.1+bacnetExt 中文整理基于 FIN 5.3.1

导读： 本页为 FIN 扩展 bacnetExt 的 API 参考文档。

以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。

目录（导读）

mixins
classes
errs
docs
Overview
Bacnet Connectors
Connector Points
Local device
Slot Details
- propId
- toBacnet
- toHaystack
- make
- objectPropsConverters
- actor
- makeActor
- makeActorCoalescing
- receive
- data
- tabRe
- _status
- hasStatus
- status
- toHaystackStatus
- toHaystackValue
- value
- processId
- remoteDeviceId
- user
- isPollingDegraded
- lastCovSubscribe
- polledList
- polligFallbackCount
- renewSubscriptionMsg
- stop
- stopSubscriberMsg
- subscribeCount
- alarms
- backupDev
- bacnetConfirmedTextMessage
- bacnetCreateObject
- bacnetDeleteObject
- bacnetDeviceCommunicationControl
- bacnetDiscoverObjects
- bacnetEnrollmentSummary
- bacnetGetDeviceInstanceNumberfromConnContext
- bacnetGetEventInformation
- bacnetGetStringTypeSupported
- bacnetReadHis
- bacnetReadObject
- bacnetReadObjectProperty
- bacnetReadPropertyMultiple
- bacnetReinitializeDevice
- bacnetScheduleRead
- bacnetSyncObjectProperty
- bacnetTimeSynchronization
- bacnetUTCTimeSynchronization
- bacnetUnconfirmedTextMessage
- bacnetWriteGroupService
- bacnetWriteObjectProperty
- bacnetWritePropertyMultiple
- batchRead
- clientConnection
- connDetails
- covs
- deviceClearLearn
- deviceLearn
- enablePolling
- onClose
- onOpen
- onPing
- onPollBucket
- onRemoved
- onSyncCur
- onSyncHis
- onUnwatch
- onUpdated
- onWatch
- onWrite
- onWrite2
- pointDetails
- restoreDev
- scheduleEffectivePeriod
- scheduleReadWeekly
- scheduleWriteDefault
- scheduleWriteException
- scheduleWriteWeekly
- shouldInitDevice
- timerFuture
- virtualDevice
- writeDelay
- writeIncRetry
- writeMaxRetry
- connTuning
- AdjustToBacnetValue
- AdjustToFanValue
- DriverToFan
- DriverToFanAdjusted
- ParseValueForComplexObject
- createAddressString
- cur
- onStart
- onStop
- scheduleSync
- amIFD
- bacnetAcknowledgeAlarm
- bacnetAddEnumPropValMapping
- bacnetAddRouterEntry
- bacnetAddToNotificationClass
- bacnetAny
- bacnetApplyNetworkPortPendingChanges
- bacnetAtomicReadFile
- bacnetAtomicWriteFile
- bacnetBackupDevice
- bacnetCharString
- bacnetCharacter
- bacnetClientRestart
- bacnetDbcsString
- bacnetDeviceDiscovery
- bacnetDiscoveryWithModel
…（其余标题见英文正文）

API 正文（英文）

| AnyPresentValuePropConvert | Implement a property converter for Present_Value property | | ApplicationSoftwareVersionPropConvert | Implement a property converter for basic ApplicationSoftwareVersion property | | ArchivePropConvert | Implement a property converter for basic Archive property | | AttemptedSamplesPropConvert | Implement a property converter for basic AckedTransitions property | | AverageValuePropConvert | Implement a property converter for basic AckedTransitions property | | AveragingConvert | | | BacNETValueStatus | | | BackupAndRestoreStatePropConvert | Implement a property converter for Last_Restart_Reason property | | BackupFailureTimeoutPropConvert | Implement a property converter for basic BackupFailureTimeout property | | BackupPreparationTimePropConvert | Implement a property converter for Backup_Preparation_Time property | | BackupPreperationTimePropConvert | Implement a property converter for basic BackupPreparationTime property | | BacnetAlarmActor | BacnetAlarmActor - handles alarms events | | BacnetCOVActor | BacnetCOVActor handles BACnet CoV messages | | BacnetConn | BacnetConn connector class for Skyspark | | BacnetConnTuningLib | Utility for working with BACnet connector tuning | | BacnetConvert | | | BacnetExt | | | BacnetIpModeConvert | | | BacnetIpUdpPortConvert | | | BacnetLib | | | BacnetModel | | | BacnetObjId | Immutable wrapper class for a BACnet Object Id Used as key for the internal subscribed objects map | | BacnetUtils | | | BacnetVirtualDevice | BacnetVirtualDevice Listens for remote devices requests | | BaseTypeConv | Base BACnet type conversion, it register converters for all common properties | | BasicPropConverter | Implements the basic BACnet object properties using the primitive types converter | | BdtConvert | | | BiasPropConvert | Implement a property converter for basic AckedTransitions property | | BinaryInputConvert | | | BinaryLightingOutputConvert | | | BinaryObjectConvert | | | BinaryOutputConvert | | | BinaryValueConvert | | | BitMaskPropConvert | Implement a property converter for basic Bit_Mask property | | BitStringAlarmValuesPropConvert | Implement a property converter for basic AlarmValues property | | BitStringPresentValuePropConvert | Implement a property converter for basic PresentValue property | | BitStringRelinquishDefaultPropConvert | Implement a property converter for basic RelinquishDefault property | | BitStringValueConvert | | | BitTextPropConvert | Implement a property converter for basic Bit_Text property | | BlinkWarnEnablePropConvert | Implement a property converter for basic BlinkWarnEnable property | | BooleanMaintenanceRequiredPropConvert | Implement a property converter for Boolean_Maintenance_Required property | | BooleanPresentValuePropConvert | Implement a property converter for PresentValue property | | BufferSizePropConvert | Implement a property converter for Buffer_Size property | | COVPeriodPropConvert | Implement a property converter for basic COV_Period property | | COVResubscriptionIntervalPropConvert | Being used by only TrendLog and GlobalGroup objects | | COVUPeriodPropConvert | Implement a property converter for basic COVU_Period property | | COVURecipientsPropConvert | Implement a property converter for basic COVU_Recipients property | | CalendarConvert | | | CalendarRec | | | ChangeOfStateCountPropConvert | Implement a property converter for Change_Of_State_Count property | | ChangeOfStateTimePropConvert | Implement a property converter for Change_Of_State_Time property | | ChangesPendingConvert | | | ChannelConvert | | | ChannelNumberPropConvert | Implement a property converter for Number_Of_States property | | ChannelValuePresentValuePropConvert | Implement a property converter for Present_Value property | | CharacterStringPresentValuePropConvert | Implement a property converter for PresentValue property | | CharacterStringRelinquishDefaultPropConvert | Implement a property converter for RelinquishDefault property | | CharacterStringValueConvert | | | ChronoRec | | | ClientCOVIncrementPropConvert | Being used by only TrendLog and GlobalGroup objects | | CommandConvert | | | ComplexConverter | Converts Complex Haystack to BACnet and vice-versa | | ComplexPropConverter | Implements the complex BACnet object properties using the complex types converter | | ConfigurationFilesPropConvert | Implement a property converter for Configuration_Files property | | ControlGroupsPropConvert | Implement a property converter for Control_Groups property | | ControlledVariableReferencePropConvert | Implement a property converter for basic Controlled_Variable_Reference property | | ControlledVariableUnitsPropConvert | Implement a property converter for Controlled_Variable_Units property | | ControlledVariableValuePropConvert | Implement a property converter for Controlled_Variable_Value property | | ConvertUtil | | | CountBeforeChangePropConvert | Implement a property converter for Count_Before_Change property | | CountChangeTimePropConvert | Implement a property converter for Count_Change_Time property | | CountPropConvert | Implement a property converter for Count property | | CurrentCommandPriorityPropConvert | Implement a property converter for basic Current_Command_Priority property | | DatabaseRevisionPropConvert | Implement a property converter for basic Database_Revision property | | DateListPropConvert | Implement a property converter for Date_List property | | DatePatternValueConvert | | | DatePresentValuePropConvert | Implement a property converter for basic PresentValue property | | DateRelinquishDefaultPropConvert | Implement a property converter for basic RelinquishDefault property | | DateTimePatternValueConvert | | | DateTimePresentValuePropConvert | Implement a property converter for basic PresentValue property | | DateTimeRelinquishDefaultPropConvert | Implement a property converter for basic RelinquishDefault property | | DateTimeValueConvert | | | DateValueConvert | | | DaylightSavingsStatusPropConvert | Implement a property converter for Daylight_Savings_Status property | | DefaulFadeTimePropConvert | Implement a property converter for Default_Fade_Time property | | DefaultProprietaryPropConvert | | | DefaultRampRatePropConvert | Implement a property converter for Default_Ramp_Rate property | | DefaultStepIncrementPropConvert | Implement a property converter for Default_Step_Increment property | | DefaultTimeoutPropConvert | Implement a property converter for basic Default_Timeout property | | DegradedObj | Degraded to polling | | DerivativeConstantPropConvert | Implement a property converter for Derivative_Constant property | | DerivativeConstantUnitsPropConvert | Implement a property converter for Derivative_Constant_Units property | | DescriptionOfHaltPropConvert | Implement a property converter for basic Description_Of_Halt property | | DescriptionPropConvert | Implement a property converter for basic Description property | | DeviceAddressBindingPropConvert | Implement a property converter for basic UTC_Time_Synchronization_Recipients property | | DeviceConvert | | | DeviceModel | | | DeviceTypePropConvert | Available for only BI, MSI, MSO, ACC and BO Implement a property converter for basic Device_Type property | | DirectReadingPropConvert | Implement a property converter for basic Direct_Reading property | | DirtyRec | | | DiscoveryModelChange | | | DoorAlarmStatusPropConvert | Implement a property converter for basic Door_Alarm_Status property | | DoorExtendedPulseTimePropConvert | Implement a property converter for Door_Extended_Pulse_Time property | | DoorMembersPropConvert | Implement a property converter for basic Door_Members property | | DoorOpenTooLongTimePropConvert | Implement a property converter for Door_Open_Too_Long_Time property | | DoorPulseTimePropConvert | Implement a property converter for Door_Pulse_Time property | | DoorStatusPropConvert | Implement a property converter for basic Door_Status property | | DoorUnlockDelayTimePropConvert | Implement a property converter for Door_Unlock_Delay_Time property | | DoubleCOVIncrementPropConvert | Implement a property converter for basic AckedTransitions property | | DoubleDeadbandPropConvert | Implement a property converter for Deadband property | | DoubleFaultHighLimitPropConvert | Implement a property converter for basic Fault_High_Limit property | | DoubleFaultLowLimitPropConvert | Implement a property converter for basic Fault_Low_Limit property | | DoubleHighLimitPropConvert | Implement a property converter for basic High_Limit property | | DoubleLowLimitPropConvert | Implement a property converter for basic Low_Limit property | | DoubleMaxPresValuePropConvert | Implement a property converter for basic Max_Pres_Value property | | DoubleMinPresValuePropConvert | Implement a property converter for basic Min_Pres_Value property | | DoublePresentValuePropConvert | Implement a property converter for PresentValue property | | DoubleRelinquishDefaultPropConvert | Implement a property converter for RelinquishDefault property | | DoubleResolutionPropConvert | Implement a property converter for basic Resolution property | | DutyWindowPropConvert | Implement a property converter for basic Duty_Window property | | EffectivePeriodPropConvert | Implement a property converter for Effective_Period property | | EgressActivePropConvert | Implement a property converter for Egress_Active property | | EgressTimePropConvert | Implement a property converter for Egress_Time property | | ElapsedActiveTimePropConvert | Implement a property converter for Elapsed_Active_Time property | | EnablePropConvert | Available for only TL, TLM, LC and EL Implement a property converter for basic Enable property | | EnumActionPropConvert | Implement a property converter for basic Action property | | EnumAlarmValuesPropConvert | Implement a property converter for basic AlarmValues property | | EnumFaultValuesPropConvert | Implement a property converter for basic Fault_Values property | | EnumFeedbackValuePropConvert | Implement a property converter for FeedbackValue property | | EnumMaintenanceRequiredPropConvert | Implement a property converter for Enum_Maintenance_Required property | | EnumPresentValuePropConvert | Implement a property converter for basic PresentValue property | | EnumRelinquishDefaultPropConvert | Implement a property converter for basic RelinquishDefault property | | EnumTrackingValuePropConvert | Implement a property converter for Enum_Tracking_Value property | | ErrorLimitPropConvert | Implement a property converter for Error_Limit property | | EventAlgorithmInhibitPropConvert | Implement a property converter for basic Event_Algorithm_Inhibit property | | EventAlgorithmInhibitRefPropConvert | Implement a property converter for basic Event_Algorithm_Inhibit_Ref property | | EventDetectionEnablePropConvert | Implement a property converter for basic Event_Detection_Enable property | | EventEnablePropConvert | Implement a property converter for basic Event_Enable property | | EventEnrollmentConvert | | | EventLogConvert | | | EventLogRecordLogBufferPropConvert | Implement a property converter for basic Fault_Type property | | EventMessageTextsConfigPropConvert | Implement a property converter for basic Event_Message_Texts_Config property | | EventMessageTextsPropConvert | Implement a property converter for basic Event_Message_Texts property | | EventParametersPropConvert | Implement a property converter for basic Event_Parameters property | | EventStatePropConvert | Implement a property converter for basic Event_State property | | EventTimeStampPropConvert | Implement a property converter for basic Event_Time_Stamps property | | EventTypePropConvert | Implement a property converter for basic Event_Type property | | ExceptionSchedulePropConvert | Implement a property converter for Exception_Schedule property | | ExecutionDelayPropConvert | Implement a property converter for Execution_Delay property | | ExpectedShedLevelPropConvert | Implement a property converter for basic Expected_Shed_Level property | | FaultParametersPropConvert | Implement a property converter for basic Fault_Parameters property | | FaultTypePropConvert | Implement a property converter for basic Fault_Type property | | FdBbmdIpConvert | | | FdSubscriptionLifetimeConvert | | | FdtConvert | | | FileAccessMethodPropConvert | Implement a property converter for basic File_Access_Method property | | FileConvert | | | FileSizePropConvert | Implement a property converter for basic File_Size property | | FileTypePropConvert | Implement a property converter for basicFile_Type property | | FirmwareRevisionPropConvert | Implement a property converter for Firmware_Revision property | | FullDutyBaselinePropConvert | Implement a property converter for basic Full_Duty_Baseline property | | GenericTypeConverter | Converts to/from Haystack and BACnet | | GlobalGroupConvert | | | GroupConvert | | | GroupMemberNamesPropConvert | Implement a property converter for basic Group_Member_Names property | | GroupMembersPropConvert | Implement a property converter for basic Group_Members property | | HaystackDictKeys | Class will contain String constants used as keys in Dictionary | | IOHandleWrapper | | | InProcessPropConvert | Implement a property converter for basic In_Process property | | InProgressPropConvert | Implement a property converter for In_Progress property | | InactiveTextPropConvert | Implement a property converter for Inactive_Text property | | InputReferencePropConvert | Implement a property converter for basic Input_Reference property | | InstanceOfPropConvert | Implement a property converter for basic Instance_Of property | | InstantaneousPowerPropConvert | Implement a property converter for Instantaneous_Power property | | IntegerFaultHighLimitPropConvert | Implement a property converter for basic Fault_High_Limit property | | IntegerFaultLowLimitPropConvert | Implement a property converter for basic Fault_Low_Limit property | | IntegerHighLimitPropConvert | Implement a property converter for basic High_Limit property | | IntegerLowLimitPropConvert | Implement a property converter for basic Low_Limit property | | IntegerMaxPresValuePropConvert | Implement a property converter for basic Max_Pres_Value property | | IntegerMinPresValuePropConvert | Implement a property converter for basic Min_Pres_Value property | | IntegerPresentValuePropConvert | Implement a property converter for PresentValue property | | IntegerRelinquishDefaultPropConvert | Implement a property converter for RelinquishDefault property | | IntegerResolutionPropConvert | Implement a property converter for basic Resolution property | | IntegerValueConvert | | | IntegralConstantPropConvert | Implement a property converter for Integral_Constant property | | IntegralConstantUnitsPropConvert | Implement a property converter for Integral_Constant_Units property | | IntervalOffsetPropConvert | Being used by only TrendLogMultiple, TrendLog and Device objects | | IpAddressConvert | | | IpDefaultGatewayConvert | | | IpDhcpEnableConvert | | | IpDhcpServerConvert | | | IpDnsServerConvert | | | IpSubnetMaskConvert | | | IsUTCPropConvert | Implement a property converter for basic Is_UTC property | | LargeAnalogValueConvert | | | LastCovSubscribeMsg | Last time a point was subscribed | | LastNotifyRecordPropConvert | Implement a property converter for Last_Notify_Record property | | LastPriorityPropConvert | Implement a property converter for Last_Priority property | | LastRestartReasonPropConvert | Implement a property converter for Last_Restart_Reason property | | LastRestoreTimePropConvert | Implement a property converter for Last_Restore_Time property | | LifeSafetyPointConvert | LifeSafetyPoint BACnet property converters | | LifeSafetyZoneConvert | LifeSafetyZone BACnet property converters | | LightingCommandDefaultPriorityPropConvert | Implement a property converter for Lighting_Command_Default_Priority property | | LightingCommandPropConvert | Implement a property converter for basic Lighting_Command property | | LightingOutputConvert | | | LightingOutputObjectConvert | | | LimitEnablePropConvert | Implement a property converter for basic Limit_Enable property | | LimitMonitoringIntervalPropConvert | Implement a property converter for basic Limit_Monitoring_Interval property | | LinkSpeedConvert | | | ListOfObjectPropertyReferencesPropConvert | Property used by Schedule and Channel objects only Implement a property converter for basic List_Of_Object_Property_References property | | LoadControlConvert | | | LocalDatePropConvert | Implement a property converter for Local_Date property | | LocalForwardingOnlyPropConvert | Implement a property converter for basic Local_Forwarding_Only property | | LocalTimePropConvert | Implement a property converter for Local_Time property | | LocationPropConvert | Implement a property converter for Location property | | LockStatusPropConvert | Implement a property converter for basic Lock_Status property | | LogDeviceObjectPropertyPropConvert | Property used by TrendLog and TrendLogMultiple objects only Implement a property converter for basic Log_DeviceObjectProperty property | | LogIntervalPropConvert | Implement a property converter for basic Log_Interval property | | LogMultipleRecordLogBufferPropConvert | Implement a property converter for Log_Buffer property | | LogObjectConvert | | | LogRecordLogBufferPropConvert | Implement a property converter for basic Log_Buffer property | | LoggingObjectPropConvert | Implement a property converter for basic Logging_Object property | | LoggingRecordPropConvert | Implement a property converter for basic Logging_Record property | | LoggingTypePropConvert | Implement a property converter for basic Logging_Type property | | LoopConvert | | | LowDiffLimitPropConvert | | | MacAddressConvert | | | MaintenanceRequiredPropConvert | Implement a property converter for basic Maintenance_Required property | | ManipulatedVariableReferencePropConvert | Implement a property converter for basic Manipulated_Variable_Reference property | | MaskedAlarmValuesPropConvert | Implement a property converter for basic Masked_Alarm_Values property | | MaxAPDULengthAcceptedPropConvert | Implement a property converter for Max_APDU_Length_Accepted property | | MaxActualValuePropConvert | Implement a property converter for Max_Actual_Value property | | MaxInfoFramesPropConvert | Implement a property converter for basic Max_Info_Frames property | | MaxMasterPropConvert | Implement a property converter for Max_Master property | | MaxPresValuePropConvert | Implement a property converter for Max_Pres_Value property | | MaxSegmentsAcceptedPropConvert | Implement a property converter for Max_Segments_Accepted property | | MaximumOutputPropConvert | Implement a property converter for Maximum_Output property | | MaximumValuePropConvert | Implement a property converter for Minimum_Value property | | MaximumValueTimestampPropConvert | Implement a property converter for basic Maximum_Value_Timestamp property | | MemberStatusFlagsPropConvert | Implement a property converter for basic Member_Status_Flags property | | MigrationTools | Functions used to migrate database elements to the new FIN 5.1 BBS based connector | | MinActualValuePropConvert | Implement a property converter for basic Min_Actual_Value property | | MinPresValuePropConvert | Implement a property converter for Min_Pres_Value property | | MinimumOffTimePropConvert | Implement a property converter for Minimum_Off_Time property | | MinimumOnTimePropConvert | Implement a property converter for Minimum_On_Time property | | MinimumOutputPropConvert | Implement a property converter for Minimum_Output property | | MinimumValuePropConvert | Implement a property converter for Minimum_Value property | | MinimumValueTimestampPropConvert | Implement a property converter for basic Minimum_Value_Timestamp property | | ModePropConvert | Implement a property converter for basic Mode property | | ModelNamePropConvert | Implement a property converter for Serial_Number property | | ModificationDatePropConvert | Implement a property converter for basic Modification_Date property | | MultiStateInputConvert | | | MultiStateObjectConvert | | | MultiStateOutputConvert | | | MultiStateValueConvert | | | NetworkNumberConvert | | | NetworkPortConvert | | | NetworkTypePropConvert | | | NodeSubtypePropConvert | Implement a property converter for Node_Subtype property | | NodeTypePropConvert | Implement a property converter for basic Node_Type property | | NotificationClassConvert | | | NotificationClassPropConvert | Implement a property converter for basic Notification_Class property | | NotificationForwarderConvert | | | NotificationParameterUtility | | | NotificationThresholdPropConvert | Implement a property converter for Notification_Threshold property | | NotifyTypePropConvert | Implement a property converter for basic Notify_Type property | | NumberOfAPDURetriesPropConvert | Implement a property converter for Number_Of_APDU_Retries property | | NumberOfStatesPropConvert | Implement a property converter for Number_Of_States property | | ObjectIdPresentValuePropConvert | Implement a property converter for basic PresentValue property | | ObjectIdPropConvert | Implement a property converter for basic ObjectIdentifier property | | ObjectListPropConvert | Implement a property converter for Object_List property | | ObjectNamePropConvert | Implement a property converter for basic ObjectName property | | ObjectPropertyReferencePropConvert | Property used by Averaging and Event Enrollment objects only Implement a property converter for basic Object_Property_Reference property | | ObjectTypePropConvert | Implement a property converter for basic ObjectType property | | OctetStringPresentValuePropConvert | Implement a property converter for basic PresentValue property | | OctetStringRelinquishDefaultPropConvert | Implement a property converter for basic RelinquishDefault property | | OctetStringValueConvert | | | OperationExpectedPropConvert | Implement a property converter for basic Operation_Expected property | | OutOfServicePropConvert | Implement a property converter for basic Out_Of_Service property | | OutputUnitsPropConvert | Implement a property converter for Output_Units property | | PointRec | Point record that is indexed by the point id | | PolarityPropConvert | Implement a property converter for Polarity property | | PortFilterPropConvert | Implement a property converter for basic Port_Filter property | | PositiveIntegerValueConvert | | | PowerPropConvert | Implement a property converter for Power property | | PrescalePropConvert | Implement a property converter for basic Prescale property | | PresentStagePropConvert | | | PresentValuePropConvert | | | PrimitivesConverter | Converts primitive Haystack to BACnet and vice-versa | | PriorityArrayPropConvert | Implement a property converter for basic Priority_Array property | | PriorityForWritingPropConvert | Being used by only Schedule and Loop objects | | PriorityPropConvert | Implement a property converter for basic Priority property | | ProcessIdentifierFilterPropConvert | Implement a property converter for basic Process_Identifier_Filter property | | ProfileLocationPropConvert | Implement a property converter for basic Profile_Location property | | ProfileNamePropConvert | Implement a property converter for basic Profile_Name property | | ProgramChangePropConvert | Implement a property converter for basic Program_Change property | | ProgramConvert | | | ProgramLocationPropConvert | Implement a property converter for basic Program_Location property | | ProgramStatePropConvert | Implement a property converter for basic Program_State property | | PropertyAccessResultPresentValuePropConvert | Implement a property converter for Present_Value property | | PropertyListPropConvert | Implement a property converter for basic Property_List property | | ProportionalConstantPropConvert | Implement a property converter for Proportional_Constant property | | ProportionalConstantUnitsPropConvert | Implement a property converter for Proportional_Constant_Units property | | ProprietaryPropConvert | Implement a property converter for Proprietary property | | ProprietaryValueObjectConvert | | | ProtocolLevelConvert | | | ProtocolObjectTypesSupported | Implement a property converter for basic PROT_OBJ_TYPES_SUPPORTED property | | ProtocolRevisionPropConvert | Implement a property converter for Protocol_Revision property | | ProtocolServicesSupported | Implement a property converter for basic PROT_SERVICES_SUPPORTED property | | ProtocolVersionPropConvert | Implement a property converter for basic Protocol_Version property | | PulseConverterConvert | | | PulseRatePropConvert | Implement a property converter for basic Pulse_Rate property | | ReadAccessResultPresentValuePropConvert | Implement a property converter for Present_Value property | | ReadOnlyPropConvert | Implement a property converter for basic Read_only property | | RealCOVIncrementPropConvert | Implement a property converter for basic AckedTransitions property | | RealDeadbandPropConvert | Implement a property converter for Deadband property | | RealFaultHighLimitPropConvert | Implement a property converter for basic Fault_High_Limit property | | RealFaultLowLimitPropConvert | Implement a property converter for basic Fault_Low_Limit property | | RealFeedbackValuePropConvert | Implement a property converter for basic Feedback_Value property | | RealHighLimitPropConvert | Implement a property converter for basic High_Limit property | | RealLowLimitPropConvert | Implement a property converter for basic Low_Limit property | | RealPresentValuePropConvert | Implement a property converter for PresentValue property | | RealRelinquishDefaultPropConvert | Implement a property converter for RelinquishDefault property | | RealResolutionPropConvert | Implement a property converter for basic Resolution property | | ReasonForHaltPropConvert | Implement a property converter for basic Reason_For_Halt property | | RecipientListPropConvert | Property used by Notification Forwarder and Notification Class objects only Implement a property converter for basic Recipient_List property | | RecordCountPropConvert | Being used by only TrendLogMultiple, TrendLog, Event Log and Device objects | | RecordsSinceNotificationPropConvert | Implement a property converter for Records_Since_Notification property | | ReliabilityEvaluationInhibitPropConvert | Implement a property converter for basic Reliability_Evaluation_Inhibit property | | ReliabilityPropConvert | Implement a property converter for basic Reliability property | | RequestedShedLevelPropConvert | Implement a property converter for basic Requested_Shed_Level property | | RequestedUpdateIntervalPropConvert | Implement a property converter for basic Requested_Update_Interval property | | RestartNotificationRecipientsPropConvert | Implement a property converter for basic Restart_Notification_Recipients property | | RestoreCompletionTimePropConvert | Implement a property converter for Restore_Completion_Time property | | RestorePreparationTimePropConvert | Implement a property converter for Restore_Preparation_Time property | | ScaleFactorPropConvert | Implement a property converter for basic Scale_Factor property | | ScalePropConvert | Implement a property converter for basic Scale property | | ScheduleConvert | | | ScheduleDefaultPropConvert | Implement a property converter for Schedule_Default property | | SchedulePointRec | | | ScheduleRec | | | ScheduleState | | | ScheduleStateMsg | | | ScheduleSyncModule | | | ScheduleSyncUtils | | | SecuredStatusPropConvert | Implement a property converter for basic Secured_Status property | | SegmentationSupportedPropConvert | Implement a property converter for Segmentation_Supported property | | SerialNumberPropConvert | Implement a property converter for Serial_Number property | | SetpointPropConvert | Implement a property converter for Setpoint property | | SetpointReferencePropConvert | Implement a property converter for basic Setpoint_Reference property | | ShedDurationPropConvert | Implement a property converter for basic Shed_Duration property | | ShedLevelDataConverter | Implement a property converter for all properties having Data type as BACnetShedLevel | | ShedLevelDescriptionsPropConvert | Implement a property converter for Shed_Level_Descriptions property | | ShedLevelsPropConvert | Implement a property converter for basic Shed_Levels property | | SilencedPropConvert | Implement a property converter for basic Silenced property | | StagingConvert | | | StartTimePropConvert | Implement a property converter for Start_Time property | | StateChangeValuesPropConvert | Implement a property converter for STATE_CHANGE_VALUES property | | StateDescriptionPropConvert | Implement a property converter for State_Description property | | StateTextPropConvert | Implement a property converter for State_Text property | | StatusFlagsPropConvert | Implement a property converter for basic StatusFLags property | | StopTimePropConvert | Implement a property converter for Stop_Time property | | StopWhenFullConvert | Implement a property converter for Stop_When_Full property | | StructuredObjectListPropConvert | Implement a property converter for Structured_Object_List property | | StructuredViewConvert | | | SubordinateAnnotationsPropConvert | Implement a property converter for Subordinate_Annotations property | | SubordinateListPropConvert | Implement a property converter for basic Subordinate_List property | | SubscribedRecipientsPropConvert | Implement a property converter for basic Subscribed_Recipients property | | SystemStatusPropConvert | Implement a property converter for System_Status property | | TimeDelayNormalPropConvert | Implement a property converter for basic TimeDelayNormal property | | TimeDelayPropConvert | Implement a property converter for basic TimeDelay property | | TimeOfActiveCountResetPropConvert | Implement a property converter for Time_Of_Active_Count_Reset property | | TimeOfDeviceRestartPropConvert | Implement a property converter for Time_Of_Device_Restart property | | TimeOfStateCountResetPropConvert | Implement a property converter for Time_Of_State_Count_Reset property | | TimePatternValueConvert | | | TimePresentValuePropConvert | Implement a property converter for basic PresentValue property | | TimeRelinquishDefaultPropConvert | Implement a property converter for basic RelinquishDefault property | | TimeSynchronizationIntervalPropConvert | Implement a property converter for basic Time_Synchronization_Interval property | | TimeSynchronizationRecipientsPropConvert | Implement a property converter for basic Time_Synchronization_Recipients property | | TimeValueConvert | | | TimerConvert | | | TimerRunningPropConvert | Implement a property converter for TIMER_RUNNING property | | TimerStatePropConvert | Implement a property converter for TIMER_STATE property | | TotalRecordCountPropConvert | Implement a property converter for Total_Record_Count property | | TrackingValuePropConvert | Implement a property converter for Tracking_Value property | | TransitionPropConvert | Implement a property converter for Transition property | | TrendLogConvert | | | TrendLogMultipleConvert | | | TriggerPropConvert | Implement a property converter for basic Trigger property | | UTCOffsetPropConvert | Implement a property converter for UTC_Offset property | | UTCTimeSynchronizationRecipientsPropConvert | Implement a property converter for basic UTC_Time_Synchronization_Recipients property | | UnWatchMsg | Remove CoV subscription for a point list | | UnitsPropConvert | Implement a property converter for basic Units property | | Unsigned64HighLimitPropConvert | Implement a property converter for basic High_Limit property | | Unsigned64LowLimitPropConvert | Implement a property converter for basic Low_Limit property | | Unsigned64MaxPresValuePropConvert | Implement a property converter for basic Max_Pres_Value property | | Unsigned64PresentValuePropConvert | Implement a property converter for PresentValue property | | UnsignedAlarmValuesPropConvert | Implement a property converter for basic AlarmValues property | | UnsignedCOVIncrementPropConvert | Implement a property converter for basic AckedTransitions property | | UnsignedDeadbandPropConvert | Implement a property converter for Deadband property | | UnsignedFaultHighLimitPropConvert | Implement a property converter for basic Fault_High_Limit property | | UnsignedFaultLowLimitPropConvert | Implement a property converter for basic Fault_Low_Limit property | | UnsignedFaultValuesPropConvert | Implement a property converter for basic Fault_Values property | | UnsignedFeedbackValuePropConvert | Implement a property converter for Feedback_Value property | | UnsignedHighLimitPropConvert | Implement a property converter for basic High_Limit property | | UnsignedLowLimitPropConvert | Implement a property converter for basic Low_Limit property | | UnsignedMaxPresValuePropConvert | Implement a property converter for basic Max_Pres_Value property | | UnsignedMinPresValuePropConvert | Implement a property converter for basic Min_Pres_Value property | | UnsignedPresentValuePropConvert | Implement a property converter for PresentValue property | | UnsignedRelinquishDefaultPropConvert | Implement a property converter for RelinquishDefault property | | UnsignedResolutionPropConvert | Implement a property converter for basic Resolution property | | UpdateIntervalPropConvert | Being used by only AnalogInput, Loop and GlobalGroup objects | | UpdateMsg | CoV update message | | UpdateTimePropConvert | Implement a property converter for basic Update_Time property | | ValidSamplesPropConvert | Implement a property converter for basic Valid_Samples property | | ValueBeforeChangePropConvert | Implement a property converter for basic Value_Before_Change property | | ValueChangeTimePropConvert | Implement a property converter for basic Value_Change_Time property | | ValueSetPropConvert | Implement a property converter for basic Value_Set property | | VarianceValuePropConvert | Implement a property converter for Variance_Value property | | VendorIdentifierPropConvert | Implement a property converter for basic Vendor_Identifier property | | VendorNamePropConvert | Implement a property converter for VendorName property | | VirtualDevice | A BACnet connector local device | | WatchMsg | CoV subscription a point list | | WeeklySchedulePropConvert | Implement a property converter for Weekly_Schedule property | | WindowIntervalPropConvert | Implement a property converter for Window_Interval property | | WindowSamplePropConvert | Implement a property converter for basic Window_Samples property | | WriteStatusPropConvert | Implement a property converter for basic Write_Status property |

errs


DataValueError	Error will be thrown when value for inquired property on device is error/failure in the choice of BACnet values
PropertyNotWritableError	Error will be thrown when property not writable and code try to convert that haystack mapping to Object

docs

Overview

The bacnet extension implements client connectivity to BACnet/IP devices. Functionality supported by the bacnet connector:

COV subscription of current value
Polling of current value
History synchronization with Trend_Log objects
Writable support for AOs, BOs and MultiState Output

Bacnet Connectors

Bacnet Connectors are defined with following tags:

bacnetConn: required marker tag
dis: display name of the connector
uri: address of device (see format below)
<bacnetForcePolling>: forces polling instead of COV subscription

The uri format for bacnet connectors is formatted:

bacnet://{host}[:port]/{deviceId}[?dnet={networkNum}&dadr={macAddr}]

The port value can be omitted, it defaults to 47808 (0xBAC0). The deviceId is the unit ID - the actual device to communicate with.

All the query options are optional:

networkNum: is the MS/TP network number
macAddr: the MAC address in hexidecimal

Connector Points

The following address tags are used for point addresses:

bacnetCur
bacnetHis
bacnetWrite

The format for these addresses is objectId:instanceNumber. For Analog and Binary BACnet objects a short version can be used in the format ObjectShortNameInstanceNumber like AI1, AO1, AV1, BI1, BO1, BV1, where AO = Analog Output, AI = Analog Input, AV = Analog Value and 1 is the object instance number. When the present value needs to be polled from a vendor proprietary BACnet object the address uses this format objectId:instanceNumber:propertyIdentifier

Local device

By default each connector will have a common shared bacnetDevice that is available to the BACnet network the connector connects to. This device is by default configured with a random instance number, see bacnetInstance.

The connector will expose a set of services like:

Who-Is
I-Am
Who-Has
I-Have
Read-Property
Read-Property-Multiple

This virtual device and its mentioned services play a role in the BACnet interoperability and is vital to make the CoV services work with some BACnet device vendors.

This device defaults can be overridden by creating a new record with the bacnetDevice Marker tag and with a user selected bacnetInstance Number tag. A bacnetDeviceRef Ref tag can be added to the bacnet extension record. This will ensure that all connectors are sharing the same device instances number across the network they talk to. The bacnetDeviceRef tag can be added at the connector level also.

If required, some services can be disabled on the virtual device by adding Bool tags such as supportsReadPropertyMultiple with value false to the bacnetDevice record.

APDUSegementTimeoutPropConvert

const class APDUSegementTimeoutPropConvert : BasicPropConverter

Implement a property converter for basic APDUSegementTimeout property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

APDUTimeoutPropConvert

const class APDUTimeoutPropConvert : BasicPropConverter

Implement a property converter for basic APDUTimeout property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

AcceptFdRegistrationsConvert

const class AcceptFdRegistrationsConvert : BasicPropConverter

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

AccessDoorConvert

class AccessDoorConvert : BaseTypeConv

Constructors


make

Fields


objectPropsConverters

Slot Details

make

new make()

objectPropsConverters

protected virtual override Str:PropertyConverter objectPropsConverters := [Str:PropertyConverter][:]

AccumulatorConvert

class AccumulatorConvert : BaseTypeConv

Constructors


make

Fields


objectPropsConverters

Slot Details

make

new make()

objectPropsConverters

protected virtual override Str:PropertyConverter objectPropsConverters := [Str:PropertyConverter][:]

AckedRequiredPropConvert

const class AckedRequiredPropConvert : BasicPropConverter

Implement a property converter for basic AckedRequired property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

AckedTransitionsPropConvert

const class AckedTransitionsPropConvert : BasicPropConverter

Implement a property converter for basic AckedTransitions property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ActionPropConvert

const class ActionPropConvert : ComplexPropConverter

Implement a property converter for basic Action property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ActionTextPropConvert

const class ActionTextPropConvert : BasicPropConverter

Implement a property converter for basic Action_Text property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ActiveCOVSubscriptionsPropConvert

const class ActiveCOVSubscriptionsPropConvert : ComplexPropConverter

Implement a property converter for basic Active_COV_Subscriptions property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ActiveTextPropConvert

const class ActiveTextPropConvert : BasicPropConverter

Implement a property converter for Active_Text property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ActorState

abstract class ActorState : Obj

Constructors


make

Fields


actor

Methods


makeActor
makeActorCoalescing
receive

Slot Details

actor

const Actor actor

make

new make(Actor actor, |This|? f := null)

makeActor

static Actor makeActor(ActorPool pool, |This| f)

makeActorCoalescing

receive

abstract Obj? receive(Obj? msg)

ActualShedLevelPropConvert

const class ActualShedLevelPropConvert : ShedLevelDataConverter

Implement a property converter for basic Actual_Shed_Level property

Methods


propId

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

AdjustValuePropConvert

const class AdjustValuePropConvert : BasicPropConverter

Implement a property converter for basic Adjust_Value property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

AlarmMsg

const class AlarmMsg : Obj

Constructors


make

Fields


data
tabRe

Slot Details

data

const Dict data

make

new make(Obj? event)

tabRe

const static Regex tabRe := Regex.fromStr("\s{2,}")

AlarmValuePropConvert

const class AlarmValuePropConvert : BasicPropConverter

Implement a property converter for Alarm_Value property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

AlertEnrollmentConvert

class AlertEnrollmentConvert : BaseTypeConv

Constructors


make

Fields


objectPropsConverters

Slot Details

make

new make()

objectPropsConverters

protected virtual override Str:PropertyConverter objectPropsConverters := [Str:PropertyConverter][:]

AlignIntervalsPropConvert

const class AlignIntervalsPropConvert : BasicPropConverter

Being used by only TrendLogMultiple, TrendLog and Device objects

Implement a property converter for basic Align_Intervals property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

AllWriteSuccessfulPropConvert

const class AllWriteSuccessfulPropConvert : BasicPropConverter

Implement a property converter for basic All_Write_Successful property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

AllowGroupDelayInhibitPropConvert

const class AllowGroupDelayInhibitPropConvert : BasicPropConverter

Implement a property converter for basic AckedTransitions property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

AnalogInputConvert

class AnalogInputConvert : AnalogObjectConvert

Constructors


make

Slot Details

make

new make()

AnalogObjectConvert

abstract class AnalogObjectConvert : BaseTypeConv

Constructors


make

Fields


objectPropsConverters

Slot Details

make

new make(BacStacObjectType objectType)

objectPropsConverters

protected virtual override Str:PropertyConverter objectPropsConverters := [Str:PropertyConverter][:]

AnalogOutputConvert

class AnalogOutputConvert : AnalogObjectConvert

Constructors


make

Slot Details

make

new make()

AnalogValueConvert

class AnalogValueConvert : AnalogObjectConvert

Constructors


make

Slot Details

make

new make()

AnyPresentValuePropConvert

const class AnyPresentValuePropConvert : ComplexPropConverter

Implement a property converter for Present_Value property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ApplicationSoftwareVersionPropConvert

const class ApplicationSoftwareVersionPropConvert : BasicPropConverter

Implement a property converter for basic ApplicationSoftwareVersion property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ArchivePropConvert

const class ArchivePropConvert : BasicPropConverter

Implement a property converter for basic Archive property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

AttemptedSamplesPropConvert

const class AttemptedSamplesPropConvert : BasicPropConverter

Implement a property converter for basic AckedTransitions property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

AverageValuePropConvert

const class AverageValuePropConvert : BasicPropConverter

Implement a property converter for basic AckedTransitions property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

AveragingConvert

class AveragingConvert : BaseTypeConv

Constructors


make

Fields


objectPropsConverters

Slot Details

make

new make()

objectPropsConverters

protected virtual override Str:PropertyConverter objectPropsConverters := [Str:PropertyConverter][:]

BacNETValueStatus

const class BacNETValueStatus : Obj

Constructors


make

Fields


_status
value

Methods


hasStatus
status
toHaystackStatus
toHaystackValue

Slot Details

_status

const Unsafe _status

hasStatus

Bool hasStatus()

make

new make(Obj? value, BACnetStatusFlags[]? status)

status

BACnetStatusFlags[]? status()

toHaystackStatus

Str toHaystackStatus()

toHaystackValue

Obj? toHaystackValue()

value

const Obj? value

BackupAndRestoreStatePropConvert

const class BackupAndRestoreStatePropConvert : BasicPropConverter

Implement a property converter for Last_Restart_Reason property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

BackupFailureTimeoutPropConvert

const class BackupFailureTimeoutPropConvert : BasicPropConverter

Implement a property converter for basic BackupFailureTimeout property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

BackupPreparationTimePropConvert

const class BackupPreparationTimePropConvert : BasicPropConverter

Implement a property converter for Backup_Preparation_Time property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

BackupPreperationTimePropConvert

const class BackupPreperationTimePropConvert : BasicPropConverter

Implement a property converter for basic BackupPreparationTime property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

BacnetAlarmActor

const class BacnetAlarmActor : Actor

BacnetAlarmActor

handles alarms events

Constructors


make

Fields


remoteDeviceId
user

Methods


processId	Get the Process ID used for subscribing to events
receive

Slot Details

make

new make(BacnetConn bacnetConn)

processId

Number? processId(BacnetConn conn := this._bacnetConn.val())

Get the Process ID used for subscribing to events

receive

virtual override Obj? receive(Obj? msg)

remoteDeviceId

const BacnetObjId remoteDeviceId

user

const User user

BacnetCOVActor

const class BacnetCOVActor : Actor

BacnetCOVActor handles BACnet CoV messages

Fields


renewSubscriptionMsg
stopSubscriberMsg

Methods


isPollingDegraded
lastCovSubscribe
polledList
polligFallbackCount
receive
stop
subscribeCount

Slot Details

isPollingDegraded

Bool isPollingDegraded(Dict point)

lastCovSubscribe

Duration? lastCovSubscribe(Dict point, BacStacObjectIdentifier id)

polledList

ConcurrentMap polledList()

polligFallbackCount

Int polligFallbackCount()

receive

virtual override Obj? receive(Obj? msg)

renewSubscriptionMsg

const static Obj renewSubscriptionMsg := "_renewSubscription_"

stop

Void stop()

stopSubscriberMsg

const static Obj stopSubscriberMsg := "_stopSubscriber_"

subscribeCount

Int subscribeCount()

BacnetConn

class BacnetConn : FinConn

BacnetConn connector class for Skyspark

Constructors


make

Fields


alarms
clientConnection
covs
enablePolling
timerFuture
virtualDevice

Methods


backupDev
bacnetConfirmedTextMessage
bacnetCreateObject
bacnetDeleteObject
bacnetDeviceCommunicationControl
bacnetDiscoverObjects
bacnetEnrollmentSummary
bacnetGetDeviceInstanceNumberfromConnContext
bacnetGetEventInformation
bacnetGetStringTypeSupported
bacnetReadHis
bacnetReadObject
bacnetReadObjectProperty
bacnetReadPropertyMultiple
bacnetReinitializeDevice
bacnetScheduleRead
bacnetSyncObjectProperty
bacnetTimeSynchronization
bacnetUTCTimeSynchronization
bacnetUnconfirmedTextMessage
bacnetWriteGroupService
bacnetWriteObjectProperty
bacnetWritePropertyMultiple
batchRead	ask driver to run the given "func" for the given objects.
connDetails
deviceClearLearn
deviceLearn
onClose
onOpen
onPing
onPollBucket
onRemoved
onSyncCur
onSyncHis
onUnwatch
onUpdated
onWatch
onWrite
onWrite2
pointDetails
receive
restoreDev
scheduleEffectivePeriod
scheduleReadWeekly
scheduleWriteDefault
scheduleWriteException
scheduleWriteWeekly
shouldInitDevice
writeDelay
writeIncRetry
writeMaxRetry

Slot Details

alarms

BacnetAlarmActor? alarms

backupDev

Grid backupDev(Str? password, Str proj)

bacnetConfirmedTextMessage

Grid bacnetConfirmedTextMessage(Obj priority, Str message, Dict? messageClass)

bacnetCreateObject

Grid bacnetCreateObject(Dict rec, Dict[] propValueDict)

bacnetDeleteObject

Grid bacnetDeleteObject(Dict rec)

bacnetDeviceCommunicationControl

Grid bacnetDeviceCommunicationControl(Number timeRem, Obj dccValue, Str? password)

bacnetDiscoverObjects

Grid bacnetDiscoverObjects(Bool refetch := true)

bacnetEnrollmentSummary

Grid bacnetEnrollmentSummary(Obj acknowledgementFilter, Dict? enrollmentFilter, Obj? eventStateFilter, Obj? eventTypeFilter, Number? minPriorityFilter, Number? maxPriorityFilter, Number? notificationClassFilter)

bacnetGetDeviceInstanceNumberfromConnContext

static Int bacnetGetDeviceInstanceNumberfromConnContext()

bacnetGetEventInformation

Grid bacnetGetEventInformation(Dict rec, Bool isFetchMoreEvents)

bacnetGetStringTypeSupported

Grid bacnetGetStringTypeSupported()

bacnetReadHis

Grid bacnetReadHis(Dict pointRec, Span range, Bool removeNull)

bacnetReadObject

Grid bacnetReadObject(Dict rec)

bacnetReadObjectProperty

Grid bacnetReadObjectProperty(Dict rec, Number prop, Number? index := null)

bacnetReadPropertyMultiple

Grid bacnetReadPropertyMultiple(Dict objectPropDict)

bacnetReinitializeDevice

Grid bacnetReinitializeDevice(Obj reinitValue, Str? password)

bacnetScheduleRead

Bool? bacnetScheduleRead()

bacnetSyncObjectProperty

Grid bacnetSyncObjectProperty(Dict rec, Number prop, Number? index := null)

bacnetTimeSynchronization

Grid bacnetTimeSynchronization(Date date, Time time)

bacnetUTCTimeSynchronization

Grid bacnetUTCTimeSynchronization(Date date, Time time)

bacnetUnconfirmedTextMessage

Grid bacnetUnconfirmedTextMessage(Obj priority, Str message, Dict? messageClass)

bacnetWriteGroupService

Grid bacnetWriteGroupService(Number groupNumber, Number writePriority, Number nListOfChannelValue, Bool fInhibitDelay, Bool inhibitDelay, Dict[]? changeList)

bacnetWriteObjectProperty

Grid bacnetWriteObjectProperty(Dict rec, Number prop, Obj? value, Number? priority := Number.<ctor>(8), Number? index := null)

bacnetWritePropertyMultiple

Grid bacnetWritePropertyMultiple(Dict objectsPropsDict)

batchRead

Void batchRead(NetObject[] list, |NetObject[]| func)

ask driver to run the given "func" for the given objects. based on connection, computes the number of objects to run on at a time

clientConnection

ClientConnection? clientConnection

connDetails

virtual override Str connDetails()

covs

BacnetCOVActor? covs

deviceClearLearn

Bool? deviceClearLearn()

deviceLearn

Grid deviceLearn(Uri? uri)

enablePolling

Bool enablePolling := true

make

new make(ConnActor actor, Dict rec)

onClose

virtual override Void onClose()

onOpen

virtual override Void onOpen()

onPing

virtual override Dict onPing()

onPollBucket

virtual override Void onPollBucket(ConnPoint[] pointList)

onRemoved

virtual override Void onRemoved()

onSyncCur

virtual override Void onSyncCur(ConnPoint[] points)

onSyncHis

virtual override Obj? onSyncHis(ConnPoint point, Span range)

onUnwatch

virtual override Void onUnwatch(ConnPoint[] points)

onUpdated

virtual override Void onUpdated(Dict oldRec, Dict newRec)

onWatch

virtual override Void onWatch(ConnPoint[] points)

onWrite

virtual override Void onWrite(ConnPoint point, Obj? val, Number finLevel)

onWrite2

virtual override Void onWrite2(ConnPoint point, Obj? val, Number finLevel, Obj? who)

pointDetails

virtual override Str pointDetails(ConnPoint point)

receive

virtual override Obj? receive(ConnMsg msg)

restoreDev

Grid restoreDev(Str? restoreVersion, Str? password, Str proj)

scheduleEffectivePeriod

Dict? scheduleEffectivePeriod(Dict? point)

scheduleReadWeekly

Map?[]? scheduleReadWeekly(Dict? point)

scheduleWriteDefault

Bool? scheduleWriteDefault(Dict? pointRec, Obj? scheduleDefault)

scheduleWriteException

Bool? scheduleWriteException(Dict? pointRec, List? scheduleList)

scheduleWriteWeekly

Bool? scheduleWriteWeekly(Dict? pointRec, Dict[] scheduleGrid, Number writeLevel)

shouldInitDevice

Bool shouldInitDevice()

timerFuture

Future? timerFuture

virtualDevice

BacnetVirtualDevice? virtualDevice

writeDelay

Duration writeDelay()

writeIncRetry

Number writeIncRetry()

writeMaxRetry

Number writeMaxRetry()

BacnetConnTuningLib

class BacnetConnTuningLib : Obj

Utility for working with BACnet connector tuning

Methods


connTuning	Read a tuning parameter from a point, connTuning or ext

Slot Details

connTuning

static Obj? connTuning(Str setting, BacnetConn conn, Dict? pointRec := null)

Read a tuning parameter from a point, connTuning or ext

BacnetConvert

class BacnetConvert : Obj

Methods


AdjustToBacnetValue	Adjust the fantom value according to the Finstack Point (record) and the Bacnet Object, in order to be set on the device.
AdjustToFanValue	Adjust the fantom value according to the Finstack Point (record) and the Bacnet Object.
DriverToFan	Convert driver (java) value to fantom value
DriverToFanAdjusted	Convert driver (java) value to fantom value, see `DriverToFan()` Adjust the fantom value accordingly, see `AdjustFanValue()`
ParseValueForComplexObject
createAddressString	Convert a list of tags (Bacnet primitive - like Unsigned, ObjectId) values to a list of fantom values.

Slot Details

AdjustToBacnetValue

static Obj? AdjustToBacnetValue(Obj? value, IBacStacPropertyIdentifier property, Dict pointRec, ValueObject? valObj)

Adjust the fantom value according to the Finstack Point (record) and the Bacnet Object, in order to be set on the device.

Str   ->  Number     (for Enum/Str points)
Bool  ->  Number     (for Bool points)

IMPORTANT: usually this function refers to the Present_Value or currValue property of the

point and object, or properties that need 'adjusting'

AdjustToFanValue

static Obj? AdjustToFanValue(Obj? fanVal, BacStacPropertyIdentifier property, Dict pointRec, ValueObject? valObj)

Adjust the fantom value according to the Finstack Point (record) and the Bacnet Object. Usually when getting Bacnet Enumeration values that will be set on Bool and Enum Finstack points.

Number  ->  Str     (for Enum points)
Number  ->  Bool    (for Bool points)

IMPORTANT: usually this function refers to the Present_Value or currValue property of the

point and object

looks more like toFolio that toFan, because it only uses Number instead on Int

DriverToFan

static Obj? DriverToFan(Obj? driverVal, BacStacObjectType objType, IBacStacPropertyIdentifier propId)

Convert driver (java) value to fantom value

null     ->  null
Boolean  ->  Bool
Integer  ->  Number
Long     ->  Number
Float    ->  Number
Double   ->  Number
anything else -> null

looks more like toFolio that toFan, because it only returns Number instead on Int, see: Integer -> Number

DriverToFanAdjusted

static Obj? DriverToFanAdjusted(Obj? driverVal, IBacStacPropertyIdentifier property, Dict pointRec, ValueObject? valObj)

Convert driver (java) value to fantom value, see DriverToFan() Adjust the fantom value accordingly, see AdjustFanValue()

looks more like toFolio that toFan, because it only uses Number instead on Int

ParseValueForComplexObject

static Obj? ParseValueForComplexObject(Obj? value, IBacStacPropertyIdentifier property, Dict pointRec, ValueObject valObj)

createAddressString

static Obj createAddressString(Obj value, Obj networkNumber)

Convert a list of tags (Bacnet primitive - like Unsigned, ObjectId) values to a list of fantom values. In addition each Sequence tag it encounters is cracked open and its internal tags are converted. For each individual tag in the list uses TagToFan() function.

looks more like toFolio that toFan, because it only uses Number instead on Int

IMPORTANT: because it checks for Sequence before calling TagToFan() - if you add in TagToFan() special convert

for Constructed types, it might not get there (be called) for the Contructed type

BacnetExt

@ExtMeta { name="bacnet"; depends=["conn","point","alarm"]; licFeature="conn" } @FinExtMeta { licFeatureExclude="enterprise"; pngIcon=`fan://bacnetExt/res/img/icon24.png` } const class BacnetExt : FinConnImplExt

Fields


scheduleSync

Methods


cur
onStart
onStop

Slot Details

cur

static BacnetExt? cur(Bool checked := true)

onStart

virtual override Void onStart()

onStop

virtual override Void onStop()

scheduleSync

const ScheduleSyncModule scheduleSync := ScheduleSyncModule.<ctor>(this)

BacnetIpModeConvert

const class BacnetIpModeConvert : BasicPropConverter

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

BacnetIpUdpPortConvert

const class BacnetIpUdpPortConvert : BasicPropConverter

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

BacnetLib

const class BacnetLib : Obj

Fields


log

Methods


amIFD
bacnetAcknowledgeAlarm	Acknowledges an alarm.
bacnetAddEnumPropValMapping	The method will save Enum and property value conversion mapping for schedule object e.g.
bacnetAddRouterEntry	Make a network Table entry manually of router.
bacnetAddToNotificationClass	Adds the connector to the provided notification class, to enable receiving alarm/event notifications.
bacnetAny	The method will convert the input data/Dict to given type.
bacnetApplyNetworkPortPendingChanges	Apply the pending changes in the stack configuration by restarting the stack with new changes
bacnetAtomicReadFile	Reads the content of a BACnet File object.
bacnetAtomicWriteFile	Writes the content of a IOHandle to a BACnet File object.
bacnetBackupDevice	Takes the backup of the Device.
bacnetCharString	The method will convert the input Str to Character String.
bacnetCharacter	The method will convert the input Str to Character Array.
bacnetClientRestart	Restart the stack
bacnetConfirmedTextMessage	The ConfirmedTextMessage service is used by a client BACnet-user to send a text message to another BACnet device.
bacnetCreateObject	Create a Bacnet Object
bacnetDbcsString	The method will convert the input Str to dbcs String.
bacnetDeleteObject	Delete a Bacnet Object
bacnetDeviceCommunicationControl	`bacnetDeviceCommunicationControl(@connRef, dccValue, timeRem, password)`
bacnetDeviceDiscovery	Discover BACnet devices and returns a grid with them.
bacnetDiscoverObjects	Discover BACnet objects from the BACnet device.
bacnetDiscoveryWithModel
bacnetDouble	The method will convert the input Number to Double.
bacnetEmptyList	The method indicates to write an empty list.
bacnetEnrollmentSummary	The GetEnrollmentSummary service is used to obtain a summary of event-initiating objects
bacnetEnum	The method will convert the input Number to Enumeration.
bacnetGetAlarmSummary	Retrieves the Alarm Summary from the device and adds them in the Alarm Extension.
bacnetGetBackupStatus	Gets the device backup information.
bacnetGetDeviceInstanceNumber	The method will return the bacnet device instance number.
bacnetGetDeviceObjectName	The method will return the bacnet device object name.
bacnetGetEventInformation	"active event states" refers to all event-initiating objects that (a) have an Event_State property whose value is not equal to NORMAL, or (b) have an Acked_Transitions property, which has at least one of the bits (TO_OFFNORMAL, TO_FAULT, TO_NORMAL) set to FALSE.
bacnetGetHandledAlarms	Returns the handled alarms from this Bacnet connector.
bacnetGetHandledEvents
bacnetGetLocalBindAddress	The method will get localBindAddress.
bacnetGetLocalDnetNumber	The method will return the local dnet number.
bacnetGetMaxDeviceInstance
bacnetGetMaxMacAddress
bacnetGetMaxNetworkNumber
bacnetGetNotificationSubscriptions	Returns all the Notification Classes this current connector receives notifications from.
bacnetGetPhysicalPortDnetNumber	The method will get physical port dnet Number.
bacnetGetStackConfigKeys	Method will return all the config keys defined by the system.
bacnetGetStringTypeSupported	Retrieves the String type supported for the connector.
bacnetGetUnhandledAlarms	Returns the unhandled alarms from this Bacnet connector This is more for testing purposes, to see we are receiving alarms.
bacnetGetUnhandledEvents	Returns the unhandled alarm events (type=event) of Bacnet connector This is more for testing purposes, to see we are receiving alarms.
bacnetIsoString	The method will convert the input Str to Iso8859 String.
bacnetJisString	The method will convert the input Str to Jisc6226 String.
bacnetLearn	Returns a grid with the BACnet objects residing on the device the connector points to.
bacnetLifeSafetyOperation	- conn : The BACnet connector used to communicate to the device
bacnetListBroadcastIps	List all the available IPv4 broadcast addresses
bacnetListLocalIps	List all the available IPv4 local addresses, excluding the loopback
bacnetLocalBindAddress	Returns the local address to which the BACnet stack is bind.
bacnetMigratePoints	This method will migrate point data from FIN 5.1.X release to FIN 5.1.7 release Accumulator and Schedule point will be migrated.
bacnetMigration	Manually call the migration functions for the current project.
bacnetNotificationsSubscribeConn	Subscribe to connector, to receive notifications for all the points from it that are bound in DB builder.
bacnetNotificationsSubscribePoint	Subscribe to connector, to receive notifications only for the provided point.
bacnetNotificationsUnsubscribeConn	Unsubscribe from connector, from receiving notifications for all the points that are bound in DB builder.
bacnetNotificationsUnsubscribePoint	Unsubscribe from connector, from receiving notifications only for the provided point.
bacnetObjectTypeList	List all standard BACnet object types
bacnetPing	Asynchronously ping an bacnet connector Examples
bacnetPropertyIdentifierList	List all standard properties that a BACnet object can support
bacnetReadEnumPropValMapping	The method will fetch all Enum and property value conversion mapping for schedule object
bacnetReadHis	Read history log from a BACnet Trend Log object
bacnetReadObject	Read all know properties for this BACnet object
bacnetReadObjectProperty	Read a BACnet property from a BACnet object
bacnetReadPoolSizeFromBbsConfig	Reads the Client_pool_size, Server_pool_size & Pdu_pool_size from the BBS config.
bacnetReadPropertyFromDB	Reads property value from our own Stack data-base, like properties from Device or Network-port Object
bacnetReadPropertyMultiple	Reads multiple object properties using the BACnet ReadPropertyMultiple service if the remote device supports it.
bacnetReadStackConfig	The method will return the Config value for inquired Config keys from /etc/bacnetExt/config.props file configKey : Config key value in string or array of string.
bacnetReadStructuredView	Reads the properties of BACnet Structured View objects for a given connector.
bacnetReal	The method will convert the input Number to Real.
bacnetRegisterAsBBMD	Registers the device as BBMD and puts the entry provided in the in the BDT table.
bacnetRegisterAsForeignDevice	@Axon
bacnetRegisterBBMDwithNetworkPort	Registers the device as BBMD using network-port object and puts the entry provided in the BBMD-BROADCAST-DISTRIBUTION-TABLE property.
bacnetRegisterForeignDeviceWithNetworkPort	Registers the device as foreign device by requesting the BBMD of the other subnet it wants to register itself.
bacnetRemoveFromNotificationClass	Removes the local device corresponding to the connector from the provided notification class, to disable receiving alarm/event notifications.
bacnetRemoveStackConfig	The method will return delete the provided config entry.
bacnetRestoreDevice	Restores the device from the already backed up data.
bacnetScheduleEffectivePeriod	Reads the effective period for a bacnet schedule point
bacnetScheduleRead	Reads the weekly schedule from a bacnet schedule point
bacnetScheduleWrite	Writes a weekly schedule to a bacnet schedule point
bacnetSetDeviceInstanceNumber	Set instance number of our device.
bacnetSetDeviceObjectName	The method will set object name of default server device.
bacnetSetLocalBindAddress	The method will set localBindAddress
bacnetSetLocalDnetNumber	The method will set the local dnet number.
bacnetSetPhysicalPortDnetNumber	The method will set physical port dnet Number.
bacnetSigned	The method will convert the input Number to Signed.
bacnetSyncCur	Asynchronously synchronize current values for given list of proxy points.
bacnetSyncHis	Import the lastest data from an BACnet `Trend Log` object to the local history database, for each point provided.
bacnetSyncObjectProperty	Function to sync BACnet object property of BACnet device point to the FIN Note:- Support is currently limited to the `units` property only.
bacnetTimeSynchronization	Synchronizes the time of the Device
bacnetUcs2String	The method will convert the input Str to UCS 2 String.
bacnetUcs4String	The method will convert the input Str to UCS 4 String.
bacnetUnRegisterBBMD	bacnetUnRegisterBBMD()
bacnetUnRegisterForeignDevice	bacnetUnRegisterForeignDevice()
bacnetUnconfirmedTextMessage	Parameters
bacnetUnregisterBBMDwithNetworkPort	bacnetUnregisterBBMDwithNetworkPort()
bacnetUnregisterForeignDeviceWithNetworkPort	bacnetUnregisterForeignDeviceWithNetworkPort()
bacnetUnsigned	The method will convert the input Number to Unsigned.
bacnetUnsigned16	The method will convert the input Number to Unsigned16.
bacnetUnsigned64	The method will convert the input Number to Unsigned64.
bacnetUpdatePoolSizeInConfig	This query updates the Server-TSML-pool, Client-TSML-pool size & Pdu-pool size
bacnetUtcTimeSynchronization	Synchronizes the time of the Device with UTC
bacnetWhoHas	Sends a WhoHas request in the network
bacnetWriteGroupService	`-nListOfChannelValue: Specifies the number of BacnetGroupChannelValue objects in changelist`
bacnetWriteNetworkPortProperty	Update/Write property value in our own Stack data-base for supported properties from Device or Network-port Object
bacnetWriteObjectProperty	Write a BACnet property value
bacnetWritePropertyMultiple	Writes multiple object properties using the BACnet WritePropertyMultiple service if the remote device supports it.
bacnetWriteStackConfig	The method will write the Config key-value to /etc/bacnetExt/config.props file Dict : key-value pair of config values
finSyncPointsInLib

Slot Details

amIFD

static Bool amIFD(Int portID := 1)

bacnetAcknowledgeAlarm

@Axon { admin=true } static Grid bacnetAcknowledgeAlarm(Obj conn, Dict alarmDict)

Acknowledges an alarm. Need to specify the connector this alarm came from.

Parameters:

conn: Ref to or a record with a bacnetConn tag
alarm: Dict representing the alarm. The dict structure must comply to the alarm's format
```
and resemble the results of funtion like
```

Returns:

String that shows the success of the operation.

bacnetAddEnumPropValMapping

@Axon { admin=true } static Grid bacnetAddEnumPropValMapping(Dict mapData)

The method will save Enum and property value conversion mapping for schedule object e.g. Let's consider Schedule Object's PRESENT_VALUE type is Enumeration and reference object is Multi-State-Value then based on PRESENT_VALUE number corresponding State_Text string is shown, here State_Text is property from where we are taking labels for Number to Enum conversion.

Examples:

bacnetAddEnumPropValMapping({"contextDevice":"DEV1", "contextObj":"SCH1", "refDevice":"DEV5", "refObj":"MSV7", "refProperty":"STATE_TEXT","scheduleObjectType":"MSV", "isOverride":false})

Parameters:

contextDevice: Device Object / Instance for which we need conversion.
```
i.e "DEV1" / "8:1" / "1" / @connRef
```
contextObj: the BACnet Object for which we need conversion (Currently Schedule Object Supported )
```
i.e. "SCH1" /"17:1"/ "SCH" /"17" /@pointRef
```
refDevice: Device Object / Instance from where we need refer reference object and property (if we need to refer property from other device)
```
i.e. "DEV5"/"8:5"/"5"/@connRef
```
refObj: the BACnet Object from where we need to refer property for conversion.(Any BACnet Object)
```
i.e. "MSV7" /"19:7" /@pointRef
```
refProperty: the BACnet Object's property from where we will refer labels for conversion. i.e. "STATE_TEXT"/ 110
```
Note:- refProperty should be Array of CharacterString
```
scheduleObjectType: schedule object type value i.e. "MSI","MSO","MSV","BI","BO","BV","CLN" etc

isOverride: Default value false

If true, it will override default conversion mapping / 
If false, it will provide mapping in case of empty list of Object Property references only.

Note:- In case of Boolean Schedule in place of refProperty we need to provide two properties one for False (refFalseProperty) and other for true (refTrueProperty)
Both are of CharacterString type.

refFalseProperty: the BACnet Object's property from where we will refer label for False. i.e. "INACTIVE_TEXT"/ 46
refTrueProperty: the BACnet Object's property from where we will refer label for True. i.e. "ACTIVE_TEXT"/ 4

bacnetAddEnumPropValMapping({"contextDevice":"DEV1", "contextObj":"SCH1", "refDevice":"DEV5", "refObj":"BO1", "refTrueProperty":"ACTIVE_TEXT", "refFalseProperty":"INACTIVE_TEXT","scheduleObjectType":"BV", "isOverride":false})

  (Recommended)

Schedule Object Conversion mapping for specific device instance, and reference object and property from same device instance bacnetAddEnumPropValMapping({"contextDevice":"DEV1", "contextObj":"SCH1", "refObj":"MSV7", "refProperty":"STATE_TEXT", "scheduleObjectType":"MSV"}) bacnetAddEnumPropValMapping({"contextDevice":"8:1", "contextObj":"17:1", "refObj":"19:7", "refProperty":110, "scheduleObjectType":19}) bacnetAddEnumPropValMapping({"contextDevice":@contextConnRef, "contextObj":@contextPointRef, "refObj":@pointRef, "refProperty":110, "scheduleObjectType":"MSV"})

(Recommended)

Schedule Object Conversion mapping for specific device instance, and reference object and property from other device instance bacnetAddEnumPropValMapping({"contextDevice":"DEV1", "contextObj":"SCH1","refDevice":"DEV5", "refObj":"MSV7", "refProperty":"STATE_TEXT","scheduleObjectType":"MSV"}) bacnetAddEnumPropValMapping({"contextDevice":"8:1", "contextObj":"17:1","refDevice":"8:5", "refObj":"19:7", "refProperty":110, "scheduleObjectType":19}) bacnetAddEnumPropValMapping({"contextDevice":@contextConnRef, "contextObj":@contextPointRef, "refDevice":@connRef, "refObj":@pointRef, "refProperty":110, "scheduleObjectType":"MSV"})

(Recommended) - for Boolean Schedules

Schedule Object Conversion mapping for specific device instance, and reference object and property from other device instance bacnetAddEnumPropValMapping({"contextDevice":"DEV1", "contextObj":"SCH1","refDevice":"DEV5", "refObj":"BO1", "refTrueProperty":"ACTIVE_TEXT", "refFalseProperty":"INACTIVE_TEXT", "scheduleObjectType":"BV"})

(cautious - Instance level Global Enum Property Value Conversion Mapping)

Schedule Object Conversion mapping for specific device instance, and reference object and property from same device instance bacnetAddEnumPropValMapping({"contextDevice":"DEV1", "contextObj":"SCH", "refObj":"MSV7", "refProperty":"STATE_TEXT", "scheduleObjectType":"MSV"}) bacnetAddEnumPropValMapping({"contextDevice":"DEV1", "contextObj":"17", "refObj":"19:7", "refProperty":110, "scheduleObjectType":"MSV"})
Note:- This mapping will applicable globally for specified device instance i.e for all schedule object of specified device instance
```
as we have not specified schedule object instance (like SCH).
```

bacnetAddRouterEntry

@Axon { admin=true } static Dict bacnetAddRouterEntry(Str address, Number dnetNumber)

Make a network Table entry manually of router. Examples:

bacnetAddRouterEntry("192.168.253.1:47808", 3)

bacnetAddToNotificationClass

@Axon { admin=true } static Grid bacnetAddToNotificationClass(Obj conn, Obj point)

Adds the connector to the provided notification class,
to enable receiving alarm/event notifications.
Low level function for debugging mostly.

Parameters:
   - conn: the BACnet connector used to communicate to the device
   - point: a point bound to a Notification Class Object or a dict ["bacnetRef":"NC1"]

bacnetAny

@Axon { admin=true } static Obj bacnetAny(Obj val, Str type)

The method will convert the input data/Dict to given type. And return it as Unsafe Obj instance. Method is typically used for write purpose. type is the Object type defined in BACnet standard.

It is not meant to be used outside the write queries. It is internal and only designed to work with write queries. And specifically for the properties where data-type is either any or some ambiguous value.

.toStr can be used with this query to get the output for debug purpose.

bacnetApplyNetworkPortPendingChanges

@Axon { admin=true } static Grid bacnetApplyNetworkPortPendingChanges()

Apply the pending changes in the stack configuration by restarting the stack with new changes

Examples: bacnetApplyNetworkPortPendingChanges()

bacnetAtomicReadFile

@Axon { admin=true } static Grid bacnetAtomicReadFile(Obj conn, Obj id, Obj handle, Number offset := Number.<ctor>(0), Number count := Number.<ctor>(1))

Reads the content of a BACnet File object.

Parameters:

conn:Obj, a BACnet connection id or record
id:Str, a BAcnet File object identifier
handle:Obj, and IOHandle to be used to write what is read from the BACnet file.
offset:Num, the offset position or the record from where to start to read from the file
count:Num, how many bytes/records to be read, defaults to max

Returns:

a Dict with these columns

size:Num, the total size read (bytes/records)
eof:Bool, marks the end of file

Example:

bacnetAtomicReadFile(@connRef, "10:1", `io/bacnetFile`)

bacnetAtomicWriteFile

@Axon { admin=true } static Dict bacnetAtomicWriteFile(Obj conn, Obj id, Obj handle, Number offset := Number.<ctor>(0), Number count := Number.<ctor>(1))

Writes the content of a IOHandle to a BACnet File object.

Parameters:

conn:Obj, a BACnet connection id or record
id:Str, a BAcnet File object identifier
handle:Obj, and IOHandle to be used to read the data to be written to the BACnet file.
offset:Num, the offset position or the record from where to start to write the BACnet file
count:Num, how many records to be written, defaults to max

Returns:

a Dict with these columns

size:Num, the total size written (bytes/records)
startPosition:Num, the start position/record of the new file

Example:

bacnetAtomicWriteFile(@connRef, "10:1", `io/bacnetFile`)

bacnetBackupDevice

@Axon { admin=true } static Grid bacnetBackupDevice(Obj conn, Str? password := null)

Takes the backup of the Device.

Parameters:

conn: the BACnet connection used to query the object properties
password: Device password. Default value is null if the password is not present in the device.

Returns:

the relative path from the project of the backed up data.

Examples:

bacnetBackupDevice(read(bacnetConn),"abc")

bacnetCharString

@Axon { admin=true } static Unsafe bacnetCharString(Str val, Obj type := "ASCII")

The method will convert the input Str to Character String. And return it as Unsafe Obj instance. Method is typically used for write purpose. By Default string type is ASCII. Other types available are UCS2, UCS4, ISO(ISO8859), JIS(JISC6226), DBCS. For types other than ASCII, pass the type name as the second parameter.

Example- bacnetCharString("Test","ISO") bacnetCharString("TEST","jis") bacnetCharString("TETS","UCS2") bacnetCharString("TETS","UCS4") bacnetCharString("TETS","dbcs")

.toStr can be used with this query to get the output for debug purpose.

bacnetCharacter

@Axon { admin=true } static Unsafe bacnetCharacter(Str val)

The method will convert the input Str to Character Array. And return it as Unsafe Obj instance. Method is typically used for write purpose.

.toStr can be used with this query to get the output for debug purpose.

bacnetClientRestart

@Axon { admin=true } static Grid bacnetClientRestart(Bool? restoreOldConfig := false)

Restart the stack

Parameters: restoreOldConfig : Send true if you want to restart the stack with old config. By default the value is false Examples: bacnetClientRestart() bacnetClientRestart(true)

bacnetConfirmedTextMessage

@Axon { admin=true } static Grid bacnetConfirmedTextMessage(Obj conn, Obj msgPriority, Str message, Dict? messageClass)

The ConfirmedTextMessage service is used by a client BACnet-user to send a text message to another BACnet device. The receiving BACnet device sends an

ack to confirm that message has been received.

Parameters:

conn: the BACnet connection used to query the object properties -msgPriority: Depicts the priority of the message. Takes the value between NORMAL and URGENT(0 and 1). -message: The message to be sent using the Confirmed Text Message Service.\ -messageClass: Takes the value in the form of dictionary. Key may be numeric or character. Values of Numeric Class is a Number whereas values in Character Class is in String format. The interpretation of the value is device's local matter.

Examples:

// Create an object
bacnetConfirmedTextMessage(read(bacnetConn), "NORMAL", "Hey There!!", {character:"xyz"})

bacnetConfirmedTextMessage(read(bacnetConn), "NORMAL", "Hey There!!", {numeric:1})

bacnetConfirmedTextMessage(read(bacnetConn), priority, Message, messageClassDict)

bacnetCreateObject

@Axon { admin=true } static Grid bacnetCreateObject(Obj conn, Obj obj, Dict[] propValueDict)

Create a Bacnet Object

Parameters:

conn: the BACnet connection used to query the object properties
obj: either a BACnet point record or a point Ref, or a string formatted as bacnetCur, i.e. objectType:objectInstance. See bacnetCur for more details
propValueDict: Array of Dict where dict is of the form property_identifier: Number, property_array_index?: Number, property_value: Tag, priority?: Number
propIndex: The index number for the property value to be written if the prop has dataype of array type. -1 is default which signifies that array index is not used.
- prop_name: integer or string value representing the object property id
- propVal: value to be written
- priority: priority level, defaults to 16

Examples:

// Create an object
 bacnetCreateObject(read(bacnetConn), "AV13", [{property_identifier:85, property_value : 42}, {property_identifier: 351, property_value: "foo", property_array_index: 1}])

bacnetDbcsString

@Axon { admin=true } static Unsafe bacnetDbcsString(Str val, Number codePage := Number.<ctor>(0))

The method will convert the input Str to dbcs String. And return it as Unsafe Obj instance. Method is typically used for write purpose. By default value of code page is 0. For other values of code page, pass it as a second argument.

.toStr can be used with this query to get the output for debug purpose. Example- bacnetDbcsString("Dbcs Test",1)

bacnetDeleteObject

@Axon { admin=true } static Grid bacnetDeleteObject(Obj conn, Obj obj)

Delete a Bacnet Object

Parameters:

conn: the BACnet connection used to query the object properties
obj: Object to be deleted from a connector.Either a BACnet point record or a point Ref, or a string formatted as bacnetCur, i.e. objectType:objectInstance. See bacnetCur for more details

Examples:

// Create an object
bacnetDeleteObject(@connRef, @pointRef)
bacnetDeleteObject(@connRef, "AV1")
bacnetDeleteObject(@connRef,"2:1")

bacnetDeviceCommunicationControl

@Axon { admin=true } static Grid bacnetDeviceCommunicationControl(Obj conn, Obj dccValue, Number? timeRem := Number.<ctor>(-1min), Str? password := "")

bacnetDeviceCommunicationControl(@connRef, dccValue, timeRem, password)
bacnetDeviceCommunicationControl(read(bacnetConn), 0, 180sec)

bacnetDeviceCommunicationControl(read(bacnetConn),"ENABLE", 2min)

bacnetDeviceDiscovery

@Axon { admin=true } static Grid bacnetDeviceDiscovery(Str broadcastAddress, Number low, Number high, Number networkNumber := Number.<ctor>(65535), Number discoveryTimeout := Number.<ctor>(8sec), Bool queryDevProps := true)

Discover BACnet devices and returns a grid with them.

Parameters:

broadcastAddress: IP broadcast address formated as a string ip:port,
```
if port is missing then default 47808 is used
```
low: lower limit of the interval of device IDs that should respond
high: higher limit of the interval of device IDs that should respond
networkNumber: network number of devices that should respond,
```
default value is 0xFFFF for broadcast
```
discoveryTimeout: timeout specified in number with time measure unit
```
default value is 8sec
```
queryDevProps: if the discovery should read device properties like "deviceName", "modelName", "vendorName"
```
default value is true
```

Example:

bacnetDeviceDiscovery("255.255.255.255", 0, 4194303)
bacnetDeviceDiscovery("255.255.255.255", 0, 4194303, 0xFFFF, 20sec)
bacnetDeviceDiscovery("255.255.255.255:47810", 0, 4194303, 0xFFFF, 10sec)

bacnetDiscoverObjects

@Axon { admin=true } static Grid bacnetDiscoverObjects(Obj conn, Bool refetch := true)

Discover BACnet objects from the BACnet device.

Parameters:

conn: the BACnet connection used to query the object properties
refetch: Read the properties again from the BACnet device

Examples:

bacnetDiscoverObjects(@connRef) bacnetDiscoverObjects(@connRef, false) bacnetDiscoverObjects(@connRef, true)

bacnetDiscoveryWithModel

static Grid bacnetDiscoveryWithModel(DiscoveryModelChange model, Str broadcastAddress, Number low, Number high, Number networkNumber, Duration discoveryTimeout, Bool queryDevProps, BacStacObjectIdentifier? objID := null, BacStacChar? objNameChar := null)

bacnetDouble

@Axon { admin=true } static Unsafe bacnetDouble(Number val)

The method will convert the input Number to Double. And return it as Unsafe Obj instance. Method is typically used for write purpose.

.toStr can be used with this query to get the output for debug purpose.

bacnetEmptyList

@Axon { admin=true } static Unsafe bacnetEmptyList()

The method indicates to write an empty list. It returns it as Unsafe Obj instance. Method is typically used for write purpose.

It is not meant to be used outside the write queries. It is internal and only designed to work with write queries.

bacnetEnrollmentSummary

@Axon { admin=true } static Grid bacnetEnrollmentSummary(Obj conn, Obj acknowledgementFilter, Obj? enrollment := null, Obj? eventState := null, Obj? eventType := null, Number? minPriority := null, Number? maxPriority := null, Number? notificationClass := null)

The GetEnrollmentSummary service is used to obtain a summary of event-initiating objects

Parameters:

conn: the BACnet connection used to query the object properties
acknowledgementFilter: It can take values from ALL/ACKED/NOT-ACKED or 0/1/2 respectively.It indicates the content of summary shall have all event-initiating objects/only those objects for which the Acked_Transitions property has a value of one in every bit position.
enrollment: Optional parameter.Only those objects for which the specified BACnetRecipient and Process Identifier are enrolled to receive
```
notifications, either confirmed or unconfirmed, shall be summarized
```
eventState: Optional parameter. It can take values from OFFNORMAL/ FAULT/ NORMAL/ ALL/ ACTIVE or 0/1/2/3/4 respectively, which
```
specifies that Only those event-initiating objects whose Event_State property matches the value specified in this parameter shall be
 included.
```
-eventType: Optional Parameter.This parameter is provided as a means of restricting the summary to only those event-initiating objects that can generate
```
event notifications with an Event_Type equal to the value of this parameter
```
-Priority Filter(minPriority,maxPriority): Optional parameter.It provides a means of restricting the summary to only those event-initiating objects
that can generate event notifications with a Priority as specified by this parameter.
notificationClass: Optional parameter.It provides a mean of restricting the summary to only those event-initiating objects that can
```
generate event notifications with a Notification Class equal to the value of this parameter.
```

Examples:

bacnetEnrollmentSummary(read(bacnetConn),0,{"device":"EE1","process_id":1},2,5,30,50,1)
bacnetEnrollmentSummary(read(bacnetConn),0, null ,null, null, null, null, null)
bacnetEnrollmentSummary(read(bacnetConn),"all",{"device":"EE1","process_id":0},"normal","out_of_range",30,50,1)

bacnetEnum

@Axon { admin=true } static Unsafe bacnetEnum(Number val)

The method will convert the input Number to Enumeration. And return it as Unsafe Obj instance. Method is typically used for write purpose.

.toStr can be used with this query to get the output for debug purpose.

bacnetGetAlarmSummary

@Axon { admin=true } static Grid bacnetGetAlarmSummary(Obj conn)

Retrieves the Alarm Summary from the device and adds them in the Alarm Extension.

Parameter:

conn: Ref to or a record with a bacnetConn tag

Returns:

Grid with the alarms retrieved from the device.

bacnetGetBackupStatus

@Axon { admin=true } static Grid bacnetGetBackupStatus(Str? filter := null)

Gets the device backup information. If filter is absent, give the data of every device. Else gives the data for that respective device.

Example-

bacnetGetBackupStatus() bacnetGetBackupStatus("DEV1")

bacnetGetDeviceInstanceNumber

@Axon { admin=true } static Number bacnetGetDeviceInstanceNumber()

The method will return the bacnet device instance number.

bacnetGetDeviceObjectName

@Axon { admin=true } static Str? bacnetGetDeviceObjectName()

The method will return the bacnet device object name.

bacnetGetEventInformation

@Axon { admin=true } static Grid bacnetGetEventInformation(Obj conn, Bool? isFetchMoreEvents := false, Obj? obj := null)

"active event states" refers to all event-initiating objects that (a) have an Event_State property whose value is not equal to NORMAL, or (b) have an Acked_Transitions property, which has at least one of the bits (TO_OFFNORMAL, TO_FAULT, TO_NORMAL) set to FALSE. This service is intended to be implemented in all devices that generate event notifications.

Parameters:

conn: the BACnet connection used to query the object properties
isFetchMoreEvents: the variable to indicate weather we need to retrieve following events or not. Default value is false
obj: either a BACnet point record or a point Ref, or a string formatted as bacnetCur, i.e. objectType:objectInstance. See bacnetCur for more details

Returns:

A grid with all event information

Examples:

bacnetGetEventInformation(read(bacnetConn), true)
bacnetGetEventInformation(read(bacnetConn), true, "AV1")
bacnetGetEventInformation(read(bacnetConn), false, "AV1")

bacnetGetHandledAlarms

@Axon { admin=true } static Grid bacnetGetHandledAlarms(Obj conn)

Returns the handled alarms from this Bacnet connector. This is more for testing purposes, to see we are receiving alarms. These alarms should also be visible in the Alarm Extension.

Parameters:

conn: the BACnet connector used to communicate to the device

Examples:

bacnetGetHandledAlarms(@connRef)

bacnetGetHandledEvents

@Axon { admin=true } static Grid bacnetGetHandledEvents(Obj conn)

bacnetGetLocalBindAddress

@Axon { admin=true } static Str bacnetGetLocalBindAddress()

The method will get localBindAddress.

Example:

bacnetGetLocalBindAddress()

bacnetGetLocalDnetNumber

@Axon { admin=true } static Number bacnetGetLocalDnetNumber()

The method will return the local dnet number.

bacnetGetMaxDeviceInstance

@Axon static Number bacnetGetMaxDeviceInstance()

bacnetGetMaxMacAddress

@Axon static Number bacnetGetMaxMacAddress()

bacnetGetMaxNetworkNumber

@Axon static Number bacnetGetMaxNetworkNumber()

bacnetGetNotificationSubscriptions

@Axon { admin=true } static Grid bacnetGetNotificationSubscriptions(Obj conn)

Returns all the Notification Classes this current connector receives notifications from.

Paramaters:

conn: the BACnet connector used to communicate to the device

Returns:

Grid with the locadDeviceId registered, the notification class to which it is registered,
and the Finstack point for whicj it is registered to receive alarms.

bacnetGetPhysicalPortDnetNumber

@Axon { admin=true } static Number bacnetGetPhysicalPortDnetNumber()

The method will get physical port dnet Number.

Example:

bacnetGetPhysicalPortDnetNumber()

bacnetGetStackConfigKeys

@Axon { admin=true } static Grid bacnetGetStackConfigKeys()

Method will return all the config keys defined by the system. Values corresponding to few keys are optional. It will not return custom keys defined by user. To get defined key-value pairs use bacnetReadStackConfig() bacnetGetStackConfigKeys()

bacnetGetStringTypeSupported

@Axon { admin=true } static Grid bacnetGetStringTypeSupported(Obj conn)

Retrieves the String type supported for the connector. Accepts as parameters:

conn: the BACnet connection used to query the object properties Examples: bacnetGetStringTypeSupported(read(bacnetConn))

bacnetGetUnhandledAlarms

@Axon { admin=true } static Grid bacnetGetUnhandledAlarms(Obj conn)

Returns the unhandled alarms from this Bacnet connector This is more for testing purposes, to see we are receiving alarms.

Parameters:

conn: the BACnet connector used to communicate to the device

Examples:

bacnetGetUnhandledAlarms(@connRef)

bacnetGetUnhandledEvents

@Axon { admin=true } static Grid bacnetGetUnhandledEvents(Obj conn)

Returns the unhandled alarm events (type=event) of Bacnet connector This is more for testing purposes, to see we are receiving alarms.

Parameters:

conn: the BACnet connector used to communicate to the device

Examples:

bacnetGetUnhandledEvents(@connRef)

bacnetIsoString

@Axon { admin=true } static Unsafe bacnetIsoString(Str val)

The method will convert the input Str to Iso8859 String. And return it as Unsafe Obj instance. Method is typically used for write purpose.

.toStr can be used with this query to get the output for debug purpose.

bacnetJisString

@Axon { admin=true } static Unsafe bacnetJisString(Str val)

The method will convert the input Str to Jisc6226 String. And return it as Unsafe Obj instance. Method is typically used for write purpose.

.toStr can be used with this query to get the output for debug purpose.

bacnetLearn

@Axon { admin=true } static Grid? bacnetLearn(Obj? conn, Uri? uri := null)

Returns a grid with the BACnet objects residing on the device the connector points to. The way this works is that a call with only the connector record will return a grid of folders for each object type that connector supports.

Example:

bacnetLearn(@some-bacnet-conn-ref)

The above will return a grid containing a dis and learn column, like:

dis,learn
"ANALOG VALUE",`ANALOG_VALUE`

Calling the function with a learn parameter will return a grid containing all objects of the learn parameter type, like:

bacnetLearn(@some-bacnet-conn-ref, `ANALOG_VALUE`)

This returns a grid like:

bacnetCur,bacnetWrite,bacnetWriteLevel,dis,is,kind,point,unit,writable
"AV10001","AV10001",8,"ALMCNT","ANALOG_VALUE","Number",M,"",M

bacnetLifeSafetyOperation

@Axon { admin=true } static Grid bacnetLifeSafetyOperation(Obj conn, Str operation, Str? requestingSource := null, Obj? obj := null)

conn : The BACnet connector used to communicate to the device
operation : The Life Safety Operation type (e.g., "SILENCE", "RESET")
requestingSource : It is a CharacterString specifying the platform or origin from which the LifeSafetyOperation service request is
```
triggered, example:"FIN"
```

obj : Either a BACnet point record or a point Ref, or a string formatted as bacnetCur, i.e. objectType:objectInstance.

See 'bacnetCur' for more details. You can pass a '@connRef' also, this is short-hand for passing the conn device address.

Supported operation values depend on the device and object state. Valid values include:

NONE , SILENCE , SILENCE_AUDIBLE , SILENCE_VISUAL , RESET , RESET_ALARM , RESET_FAULT
UNSILENCE , UNSILENCE_AUDIBLE  , UNSILENCE_VISUAL

Example usages:

bacnetLifeSafetyOperation(read(bacnetConn), "RESET")
bacnetLifeSafetyOperation(read(bacnetConn), "SILENCE","FIN", "LSP1")
bacnetLifeSafetyOperation(read(bacnetConn), "UNSILENCE","FIN")

bacnetListBroadcastIps

@Axon static Grid bacnetListBroadcastIps()

List all the available IPv4 broadcast addresses

bacnetListLocalIps

@Axon static Grid bacnetListLocalIps()

List all the available IPv4 local addresses, excluding the loopback

bacnetLocalBindAddress

@Axon { admin=true } static Obj? bacnetLocalBindAddress()

Returns the local address to which the BACnet stack is bind.

bacnetMigratePoints

@Axon { admin=true } static Dict bacnetMigratePoints()

This method will migrate point data from FIN 5.1.X release to FIN 5.1.7 release Accumulator and Schedule point will be migrated. This function should be run once, after FIN update

Example: bacnetMigratePoints()

bacnetMigration

@Axon { admin=true } static Void bacnetMigration(Dict ops := Etc.makeDict(["point":Marker.val]))

Manually call the migration functions for the current project. The migration process adjusts the connector related records to conform to the requirements of the latest FIN versions. The migration function is designed to be run only once, except if the force option is provided.

Parameters:

ops The options to use for migration, default is point, valid options are:

'conn', 'point', 'alarm'
'force' Will force the migration run regardless if it was already done.

Example:

// Migrate point records, forced - as it is not done as part of the automatic migration
bacnetMigration({point, force})
// Migrate conn and points
bacnetMigration({conn, point})

bacnetNotificationsSubscribeConn

@Axon { admin=true } static Grid bacnetNotificationsSubscribeConn(Obj conn)

Subscribe to connector, to receive notifications for all the points from it that are bound in DB builder.

Parameters:

conn: the BACnet connector used to communicate to the device

Return:

Grid with the localDeviceId that was subscribed, each point to receive alarms for, and
each Notification Class in which it was registered.

bacnetNotificationsSubscribePoint

@Axon { admin=true } static Grid bacnetNotificationsSubscribePoint(Obj conn, Obj point)

Subscribe to connector, to receive notifications only for the provided point.

Parameters:

conn: the BACnet connector used to communicate to the device
point: point from Connector bound in DB

Return:

Grid with the localDeviceId that was subscribed, the point to receive alarms for, and
each Notification Class in which it was registered.

bacnetNotificationsUnsubscribeConn

@Axon { admin=true } static Grid bacnetNotificationsUnsubscribeConn(Obj conn)

Unsubscribe from connector, from receiving notifications for all the points that are bound in DB builder.

Parameters:

conn: the BACnet connector used to communicate to the device

Returns:

Grid with the localDeviceId that was unsubscribed, each point and it's Notification Classes
from which it was unregistered.

bacnetNotificationsUnsubscribePoint

@Axon { admin=true } static Grid bacnetNotificationsUnsubscribePoint(Obj conn, Obj point)

Unsubscribe from connector, from receiving notifications only for the provided point.

Parameters:

conn: the BACnet connector used to communicate to the device
point: point from Connector bound in DB

Returns:

Grid with the localDeviceId that was unsubscribed, the point and it's Notification Classes
from which it was unregistered.

bacnetObjectTypeList

@Axon { admin=true } static Grid bacnetObjectTypeList()

List all standard BACnet object types

bacnetPing

@Axon { admin=true } static Obj? bacnetPing(Obj conn)

Asynchronously ping an bacnet connector Examples:

read(bacnetConn).bacnetPing
bacnetPing(bacnetConnId)

Side effects:

performs async network IO on background thread
bacnetDevice: updated if ping successful
bacnetVersion: updated if ping successful

bacnetPropertyIdentifierList

@Axon { admin=true } static Grid bacnetPropertyIdentifierList()

List all standard properties that a BACnet object can support

bacnetReadEnumPropValMapping

@Axon { admin=true } static Dict[] bacnetReadEnumPropValMapping()

The method will fetch all Enum and property value conversion mapping for schedule object

Examples:

bacnetReadEnumPropValMapping()

bacnetReadHis

@Axon { admin=true } static Grid bacnetReadHis(Obj conn, Obj obj, Obj range, Bool removeNull := false)

Read history log from a BACnet Trend Log object

Parameters:

conn: the BACnet connection used to query the object properties
obj: either a BACnet Trend Log point record or a point Ref, or a string formatted as bacnetHis, i.e. objectType:objectInstance. See bacnetHis for more details
dateTimeRange: a date time range
removeNull: option to remove log entries that have a Null recorded value. Defualt is false

Returns:

A grid with ts, val columns

Examples:

bacnetReadHis(@connRef, @pointRef, now() -7day .. now())
bacnetReadHis(@connRef, "20:1", now() -7day .. now(), true)

bacnetReadObject

@Axon { admin=true } static Grid bacnetReadObject(Obj conn, Obj obj)

Read all know properties for this BACnet object

Parameters:

conn: the BACnet connection used to query the object properties
obj: either a BACnet point record or a point Ref, or a string formatted as bacnetCur, i.e. objectType:objectInstance. See bacnetCur for more details

Returns:

A grid with all known object properties.

bacnetReadObjectProperty

@Axon { admin=true } static Grid bacnetReadObjectProperty(Obj conn, Obj obj, Obj prop, Number? index := null)

Read a BACnet property from a BACnet object

Parameters:

conn: the BACnet connection used to query the object properties
obj: either a BACnet point record or a point Ref, or a string formatted as bacnetCur, i.e. objectType:objectInstance. See bacnetCur for more details. You can pass a @connRef also, this is short-hand for passing the conn device address.
prop: integer or string value representing the object's property id

index: the integer index of the property to read, if the value of that property is an array.

Remember: that arrays are indexed starting with 1 in Bacnet: and that index 0 returns the length of the index.

Examples:

// Read present value
bacnetReadObjectProperty(@connRef, @pointRef, 85)
bacnetReadObjectProperty(@connRef, "AV1", "present_value")
bacnetReadObjectProperty(@connRef,"2:1", 85)
// Read the 'object_name' property on the device object that '@connRef' points to.
bacnetReadObjectProperty(@connRef, @connRef, "object_name")
// Read the 'object_list' size property on the device object that '@connRef' points to.
bacnetReadObjectProperty(@connRef, @connRef, "object_list", 0)

bacnetReadPoolSizeFromBbsConfig

@Axon { admin=true } static Grid bacnetReadPoolSizeFromBbsConfig()

Reads the Client_pool_size, Server_pool_size & Pdu_pool_size from the BBS config.

bacnetReadPropertyFromDB

@Axon { admin=true } static Grid bacnetReadPropertyFromDB(Obj obj, Obj prop, Number? index := null)

Reads property value from our own Stack data-base, like properties from Device or Network-port Object

Parameters:

obj: either a BACnet point record or a point Ref, or a string formatted as bacnetCur, i.e. objectType:objectInstance.
prop: integer or string value representing the object's property id
- index: the integer index of the property to read, if the value of that property is an array.

Examples:

bacnetReadPropertyFromDB("NP1", 75) bacnetReadPropertyFromDB(8:1, "object_list") bacnetReadPropertyFromDB("DEV1", "object_list", 0)

bacnetReadPropertyMultiple

@Axon { admin=true } static Grid bacnetReadPropertyMultiple(Obj conn, Dict objectPropDict)

Reads multiple object properties using the BACnet ReadPropertyMultiple service if the remote device supports it. Parameters:

conn: the BACnet connection used to query the object properties
objectPropDict: a Dict with BACnet object Ids as keys and Dict of BACnet object properties as values The dict format is: {objectId1:{prop_name1,prop_name2},objectId2:{prop_name1,prop_name2}}

Examples:

// Read present value and object name from 2 objects

bacnetReadPropertyMultiple(@connRef, {av1:{present_value, object_name}, av2:{present_value, object_name}})

bacnetReadStackConfig

@Axon { admin=true } static Grid bacnetReadStackConfig(Obj? configKeys := null)

The method will return the Config value for inquired Config keys from /etc/bacnetExt/config.props file
configKey : Config key value in string or array of string. And empty param to read all values.

Examples:

bacnetReadStackConfig()
bacnetReadStackConfig("bacnetRetryCount")
bacnetReadStackConfig("actorTimeout")
bacnetReadStackConfig("bacnetInstance")
bacnetReadStackConfig("dnetNumber")
bacnetReadStackConfig(["dnetNumber", "bacnetInstance"])

bacnetReadStructuredView

@Axon { admin=true } static Grid bacnetReadStructuredView(Obj conn, Bool refetch := true)

Reads the properties of BACnet Structured View objects for a given connector.

Parameters:

conn: the BACnet connection used to query the object properties
refetch: Read the properties again from the BACnet device

Examples:

bacnetReadStructuredView(@connRef) bacnetReadStructuredView(@connRef, false) bacnetReadStructuredView(@connRef, true)

bacnetReal

@Axon { admin=true } static Unsafe bacnetReal(Number val)

The method will convert the input Number to Real. And return it as Unsafe Obj instance. Method is typically used for write purpose.

.toStr can be used with this query to get the output for debug purpose.

bacnetRegisterAsBBMD

@Deprecated static Grid bacnetRegisterAsBBMD(Obj[][]? bbmdEntries := null, Number maxFdtEntries := Number.<ctor>(16), Bool? executeWriteBDT := true, Bool? twoHops := true)

Registers the device as BBMD and puts the entry provided in the in the BDT table. Also self entry is automatically made if no parameters is passed in the BDT table.

Parameters:

-bbmdEntries: The BDT table entries in the BBMD.
-maxFdtEntries: maximal number of entries in FDT. Default value is 16. Range (1-65535) 
-executeWriteBDT: false- Do now allow Write BDT to overwrite current BDT entries, true- Allow Write BDT
-twoHops: false- means direct broadcast, and true- denotes unicast method using another BBMD

Examples:

// Create an object
bacnetRegisterAsBBMD([["192.168.253.1",47808,"255.255.255.0"],["192.168.253.111",47808,"255.255.255.0"]])
bacnetRegisterAsBBMD([["192.168.253.1",47808,"255.255.255.0"],["192.168.253.111",47808,"255.255.255.0"]], 25, true, false)

bacnetRegisterAsBBMD()

bacnetRegisterAsBBMD([[ip1,port1,subnet1],[ip2,port2,subnet2]]

@Axon

bacnetRegisterAsForeignDevice

@Deprecated static Grid bacnetRegisterAsForeignDevice(Str ipPort, Number portNum, Number fdRegTimeout, Number timeToLive, Number fdRegRetries := Number.<ctor>(3))

@Axon

bacnetRegisterBBMDwithNetworkPort

@Axon { admin=true } static Grid bacnetRegisterBBMDwithNetworkPort(Obj? bbmdEnteries := null, Bool? acceptFdRegistration := true, Number maxFdtEntries := Number.<ctor>(16), Bool? twoHops := true)

Registers the device as BBMD  using network-port object and puts the entry provided in the BBMD-BROADCAST-DISTRIBUTION-TABLE property.
Also self entry is automatically made if no parameters is passed in the BDT table.

Parameters:
   -bbmdEntries: The BDT table entries in the BBMD.
	-acceptFdRegistration: If BBMD supports Foreign-device registration with BBMD or not. Sets BBMD-ACCEPT-FD-REGISTRATIONS property.
   -maxFdtEntries: Maximal number of entries in FDT. Default value is 16. Range (1-65535)
	-twoHops:  false- means direct broadcast, and true- denotes unicast method using another BBMD

Examples:
	bacnetRegisterBBMDwithNetworkPort()
	bacnetRegisterBBMDwithNetworkPort([["192.168.253.1",47808,"255.255.255.0"]])
	bacnetRegisterBBMDwithNetworkPort([["192.168.253.1",47808,"255.255.255.0"],["192.168.253.111",47808,"255.255.255.0"]])
	bacnetRegisterBBMDwithNetworkPort([["192.168.253.1",47808,"255.255.255.0"],["192.168.253.111",47808,"255.255.255.0"]], true, 25, false)

bacnetRegisterForeignDeviceWithNetworkPort

@Axon { admin=true } static Grid bacnetRegisterForeignDeviceWithNetworkPort(Str ipUdp, Number timeToLive, Number fdRegTimeout, Number fdRegRetries := Number.<ctor>(3))

Registers the device as foreign device by requesting the BBMD of the other subnet it wants to register itself. This query internally uses Network-port object properties.

Parameters:

ipUdp: The ip address and port number separated by :.It is the ip and port number of BBMD which accepts the request of the device and make its entry in the FDT(Foreign Device Table) and register the connector as a Foreign device.
timeToLive(in seconds)- The time for which the device is registered as Foreign device in the subnet. Note that the time provided is then added with 30 seconds(grace time). After this time, the BBMD flushes the entry of Foreign device from the FDT.
fdRegTimeout: Timeout for foreign Device Registration(seconds)
- fdRegRetries- Foreign device registration retry count

Examples:

// Create an object
bacnetRegisterForeignDeviceWithNetworkPort("192.168.253.136:47808",1800, 1200 )
bacnetRegisterForeignDeviceWithNetworkPort("192.168.253.136:47810",1800, 180, 5)

bacnetRemoveFromNotificationClass

@Axon { admin=true } static Grid bacnetRemoveFromNotificationClass(Obj conn, Obj point)

Removes the local device corresponding to the connector from the provided
notification class, to disable receiving alarm/event notifications.
Low level function for debugging mostly.

Parameters:
   - conn: the BACnet connector used to communicate to the device
   - point: a point bound to a Notification Class Object or a dict ["bacnetRef":"NC1"]

bacnetRemoveStackConfig

@Axon { admin=true } static Grid bacnetRemoveStackConfig(Str configKey)

The method will return delete the provided config entry.

NOTE : Use this method very carefully, removing some system config key may lead to system instability.

Examples:

bacnetRemoveStackConfig("test")

bacnetRestoreDevice

@Axon { admin=true } static Grid bacnetRestoreDevice(Obj conn, Str? restoreVersion := null, Str? password := null)

Restores the device from the already backed up data.

Parameters:

conn: the BACnet connection used to query the object properties
restoreVersion: The backup folder to which device has to be restored. If backup data has to be used of the same device as represented by bacnetConn, directly give the name of the backupVersion (Example - Dev3_20200714_193450). If backup data has to be used of the different device as represented by bacnetConn, give device name followed by a / and then the name of the backupVersion (Example - Dev3/Dev3_20200714_193450). By default (if nothing is passed) it takes the latest backed up data.(Only if the name of the folder is not changed manually.) If the name of the folder is changed manually and has to be restored, specify the version explicitly.

Note: The restoreVersion parameter is case sensitive and will accept only exact names.

password: Device password.

Examples:

bacnetRestoreDevice(read(bacnetConn),"Dev3_20200714_193450","example_password") for restoring backup data contained in

folder io/BacnetBackupData/Dev3/Dev3_20200714_193450 (if bacnetConn represents device with instance number 3).

bacnetRestoreDevice(read(bacnetConn),"Dev3/Dev3_20200714_193450","example_password") for restoring backup data contained in

folder io/BacnetBackupData/Dev3/Dev3_20200714_193450 (if bacnetConn represents device with instance number other than 3 and backup data has to be used of Device 3).

bacnetRestoreDevice(read(bacnetConn),"latestBackup","example_password")

(latestBackup will be searched in the folder representing with the instance number represented by device of bacnetConn)

bacnetRestoreDevice(read(bacnetConn))

Takes the latest backup data to restore.(Searches the data on the basis of folder name.
 Hence if folder name is changed manually, it won't take into account the respective folder)

bacnetScheduleEffectivePeriod

@Axon { admin=true } static Grid bacnetScheduleEffectivePeriod(Obj conn, Obj point)

Reads the effective period for a bacnet schedule point

Paramaters:

conn: Ref to or a record with a bacnetConn tag
point: Ref to or a point record that has a bacnetCur pointing to a bacnet schedule, or a string with a valid bancet schedule object address

Returns:

a grid with start and end dates Examples:

read(bacnetConn).bacnetScheduleEffectivePeriod(@pointRef)
read(bacnetConn).bacnetScheduleEffectivePeriod("17:2")

bacnetScheduleRead

@Axon { admin=true } static Grid bacnetScheduleRead(Obj conn, Obj point)

Reads the weekly schedule from a bacnet schedule point

Paramaters:

conn: Ref to or a record with a bacnetConn tag
point: Ref to or a point record that has a bacnetCur pointing to a bacnet schedule, or a string with a valid bancet schedule object address

Returns:

a grid with entries for the week, the first day is Monday,
each day has a midnight entry

Examples:

read(bacnetConn).bacnetScheduleRead(@pointRef)
read(bacnetConn).bacnetScheduleRead("SCH2")

bacnetScheduleWrite

@Axon { admin=true } static Grid bacnetScheduleWrite(Obj conn, Obj point, Grid schedule, Number writeLevel := Number.<ctor>(8))

Writes a weekly schedule to a bacnet schedule point

Paramaters:

conn: Ref to or a record with a bacnetConn tag
point: Ref to or a point record that has a bacnetCur pointing to a bacnet schedule, or a string with a valid bancet schedule object address

grid: A grid containing events as ts:val pair.

Each day needs to have a midnight entry with a null value.
The grid values are always written Monday to Sunday, no matter the order they are in the grid.

writeLevel: optional parameter specifying the bacnet priority level to write to, default is 8

Returns:

Grid with true for successful write, false otherwise

Examples:

read(bacnetConn).bacnetScheduleWrite(@pointRef, scheduleHis(@19e846bf-9baaa022,thisWeek() +1day , {timeline}))
read(bacnetConn).bacnetScheduleWrite("SCH2", scheduleHis(@19e846bf-9baaa022,thisWeek() +1day , {timeline}))

bacnetSetDeviceInstanceNumber

@Axon { admin=true } static Grid bacnetSetDeviceInstanceNumber(Number devInstance, Bool? reinitStack := true)

Set instance number of our device. Stack gets reinitialize as server using that instance number

Parameters:

devInstance: Instance of our device object
reinitStack: If true stack will be reinitialized with this new devInstance number.
Else till the time stack in not reinitialized old devInstance number will be used

Returns:

A grid with status of device instance.

bacnetSetDeviceObjectName

@Axon { admin=true } static Grid bacnetSetDeviceObjectName(Str objectName, Bool? reinitStack := true)

The method will set object name of default server device. Parameters:

objectName: object name of device object
reinitStack: If true stack will be reinitialized with this new device object name.
Else till the time stack in not reinitialized old device object name will be used

Example:

bacnetSetDeviceObjectName("FIN Connector")

bacnetSetLocalBindAddress

@Axon { admin=true } static Grid bacnetSetLocalBindAddress(Str localBindAddress, Bool? reinitStack := true)

The method will set localBindAddress

localBindAddress: bind address for stack
reinitStack: If true stack will be reinitialized with this new devInstance number.
```
Else till the time stack in not reinitialized old devInstance number will be used
```

Example:

bacnetSetLocalBindAddress("192.168.116.2:47808") bacnetSetLocalBindAddress("0.0.0.0:47808")

bacnetSetLocalDnetNumber

@Axon { admin=true } static Grid bacnetSetLocalDnetNumber(Number dnetInstance, Bool? reinitStack := true, Bool? checkDuplicateServerNetwork := true)

The method will set the local dnet number. After calling this method, the stack will re-init and if any BBMD or FD is registered, the entries will get deleted due to re-initialization of stack.

Examples

bacnetSetLocalDnetNumber(1)

bacnetSetPhysicalPortDnetNumber

@Axon { admin=true } static Grid bacnetSetPhysicalPortDnetNumber(Number physicaldnetNumber, Bool? reinitStack := true, Bool? checkDuplicateLocalNetwork := true)

The method will set physical port dnet Number.

Example:

bacnetSetPhysicalPortDnetNumber(5)

bacnetSigned

@Axon { admin=true } static Unsafe bacnetSigned(Number val)

The method will convert the input Number to Signed. And return it as Unsafe Obj instance. Method is typically used for write purpose.

.toStr can be used with this query to get the output for debug purpose.

bacnetSyncCur

@Axon { admin=true } static Obj? bacnetSyncCur(Obj points)

Asynchronously synchronize current values for given list of proxy points. The point list may be any value supported by toRecList(). The points must have the following tags configured:

bacnetConnRef
bacnetCur

This call updates the following point tags:

curVal: current value of the point
curStatus: status of the point (down/fault on failure)
curErr: error message on failure

bacnetSyncHis

@Axon { admin=true } static Obj? bacnetSyncHis(Obj points, Obj? range := null)

Import the lastest data from an BACnet Trend Log object to the local history database, for each point provided.

The points are a list of points (folio records)

Each point record must contain these tags:

bacnetConnRef: references the BACnet connector
bacnetHis: reference to the Trend Log object
his: all the standard historized point tags

If the range is unspecified, then an attempt is made to synchronize any data after hisEnd (last timestamp read).

Side effects:

performs blocking network IO
performs bacnetPing if first comms with bacnet conn
updates bacnetHis record with history data
updates hisStatus tag transiently
updates hisErr tag transiently

Examples:

bacnetSyncHis(readAll(point and <filter>))
readAll(point and <filter>).bacnetSyncHis()
readAll(point and <filter>).bacnetSyncHis(now()-1year..now())

bacnetSyncObjectProperty

@Axon { admin=true } static Grid bacnetSyncObjectProperty(Obj conn, Obj obj, Obj prop, Number? index := null)

Function to sync BACnet object property of BACnet device point to the FIN Note:- Support is currently limited to the units property only.

Parameters:

conn: the BACnet connection used to query the object properties
obj: either a BACnet point record or a point Ref, or a string formatted as bacnetCur, i.e. objectType:objectInstance. See bacnetCur for more details. You can pass a @connRef also, this is short-hand for passing the conn device address.
prop: integer or string value representing the object's property id
index: the integer index of the property to read, if the value of that property is an array.

Examples:

bacnetSyncObjectProperty(@connRef, @pointRef, "units")
bacnetSyncObjectProperty(@connRef, "AV1", "units")
bacnetSyncObjectProperty(@connRef, "2:1", 117)

bacnetTimeSynchronization

@Axon { admin=true } static Grid bacnetTimeSynchronization(Obj conn, Date date, Time time)

Synchronizes the time of the Device

Parameters:

conn: the BACnet connection used to query the object properties
date: Date of the device to be synchronized.
time: Time of the device to be synchronized.

Examples:

bacnetTimeSynchronization(read(bacnetConn),2020-12-13,04:06:23)

bacnetTimeSynchronization(read(bacnetConn),now().date,now().time)

bacnetUcs2String

@Axon { admin=true } static Unsafe bacnetUcs2String(Str val)

The method will convert the input Str to UCS 2 String. And return it as Unsafe Obj instance. Method is typically used for write purpose.

.toStr can be used with this query to get the output for debug purpose.

bacnetUcs4String

@Axon { admin=true } static Unsafe bacnetUcs4String(Str val)

The method will convert the input Str to UCS 4 String. And return it as Unsafe Obj instance. Method is typically used for write purpose.

.toStr can be used with this query to get the output for debug purpose.

bacnetUnRegisterBBMD

@Deprecated static Grid bacnetUnRegisterBBMD(Bool? reinitStack := true)

bacnetUnRegisterBBMD()

This query will Unregister BBMD and delete BBMD details from stack.

@Axon

bacnetUnRegisterForeignDevice

@Deprecated static Grid bacnetUnRegisterForeignDevice(Bool? reinitStack := true)

bacnetUnRegisterForeignDevice()

This query will delete Foreign device details from stack database.

@Axon

bacnetUnconfirmedTextMessage

@Axon { admin=true } static Grid bacnetUnconfirmedTextMessage(Obj conn, Obj msgPriority, Str message, Dict? messageClass)

Parameters:

conn: the BACnet connection used to query the object properties -msgPriority: Depicts the priority of the message. Takes the value between NORMAL and URGENT(0 and 1). -message: The message to be sent using the Confirmed Text Message Service.\ -messageClass: Takes the value in the form of dictionary. Key may be umeric or character. Values of Numeric Class is a Number whereas values in Character Class is in String format.The interpretation of the value is device's local matter.

Examples:

// Create an object
bacnetUnconfirmedTextMessage(read(bacnetConn), "NORMAL","Hey There!!", {character:"xyz"})

bacnetUnconfirmedTextMessage(read(bacnetConn), "NORMAL","Hey There!!", {numeric:1})

bacnetUnconfirmedTextMessage(read(bacnetConn), priority, Message, messageClassDict)

bacnetUnregisterBBMDwithNetworkPort

@Axon { admin=true } static Grid bacnetUnregisterBBMDwithNetworkPort(Bool? reinitStack := true)

bacnetUnregisterBBMDwithNetworkPort()

This query will Unregister BBMD from network-port object

bacnetUnregisterForeignDeviceWithNetworkPort

@Axon { admin=true } static Grid bacnetUnregisterForeignDeviceWithNetworkPort(Bool? reinitStack := true)

bacnetUnregisterForeignDeviceWithNetworkPort()

This query will delete Foreign device details from stack database.

bacnetUnsigned

@Axon { admin=true } static Unsafe bacnetUnsigned(Number val)

The method will convert the input Number to Unsigned. And return it as Unsafe Obj instance. Method is typically used for write purpose.

.toStr can be used with this query to get the output for debug purpose.

bacnetUnsigned16

@Axon { admin=true } static Unsafe bacnetUnsigned16(Number val)

The method will convert the input Number to Unsigned16. And return it as Unsafe Obj instance. Method is typically used for write purpose.

.toStr can be used with this query to get the output for debug purpose.

bacnetUnsigned64

@Axon { admin=true } static Unsafe bacnetUnsigned64(Str val)

The method will convert the input Number to Unsigned64. And return it as Unsafe Obj instance. Method is typically used for write purpose.

.toStr can be used with this query to get the output for debug purpose.

bacnetUpdatePoolSizeInConfig

@Axon { admin=true } static Grid bacnetUpdatePoolSizeInConfig(Number cliTsmSize := Number.<ctor>(150), Number srvTsmSize := Number.<ctor>(150), Number pduPoolSize := Number.<ctor>(200), Bool? reinitStack := true)

This query updates the Server-TSML-pool, Client-TSML-pool size & Pdu-pool size

in the bbs.conf. We generally need to update Server-tsml-pool size on devices where load is high. Updating this parameter increases the pool size of stuck thus enabling it to handle large load.

Parameters:

cliTsmSize: Client pool size
srvTsmSize: Server pool size
pduPoolSize: Pdu pool size
reinitStack: Init stack, by default true

Examples:

bacnetUpdatePoolSizeInConfig(1200, 1000, 2000)
bacnetUpdatePoolSizeInConfig()

bacnetUtcTimeSynchronization

@Axon { admin=true } static Grid bacnetUtcTimeSynchronization(Obj conn, Date date, Time time)

Synchronizes the time of the Device with UTC

Parameters:

conn: the BACnet connection used to query the object properties
date: Date of the device to be synchronized.
time: Time of the device to be synchronized.

Examples:

bacnetUtcTimeSynchronization(read(bacnetConn),2020-12-13,04:06:23)

bacnetUtcTimeSynchronization(read(bacnetConn),now().date,now().time)

bacnetWhoHas

@Axon { admin=true } static Grid bacnetWhoHas(Str broadcastAddress, Number low, Number high, Obj obj, Number networkNumber := Number.<ctor>(65535), Number discoveryTimeout := Number.<ctor>(8sec), Bool queryDevProps := true)

Sends a WhoHas request in the network

Parameters:

broadcastAddress: IP broadcast address formated as a string ip:port,
```
if port is missing then default 47808 is used
```
low: lower limit of the interval of device IDs that should respond
high: higher limit of the interval of device IDs that should respond
obj: object we want to send to WHoHas request. It can be ObjectId (AI1 or 0:1) or the ObjectName (AI_1)
- networkNumber: network number of devices that should respond,
```
default value is 0xFFFF for broadcast
```
- discoveryTimeout: timeout specified in number with time measure unit
```
default value is 8sec
```
- queryDevProps: if the discovery should read device properties like "deviceName", "modelName", "vendorName"
```
default value is true
```

Example:

bacnetWhoHas("255.255.255.255", 0, 4194303, "AI1")
bacnetWhoHas("255.255.255.255", 0, 4194303, "AI_5",0xFFFF, 20sec)
bacnetWhoHas("255.255.255.255:47810", 0, 4194303, "1:1",0xFFFF, 10sec)

bacnetWriteGroupService

@Axon { admin=true } static Grid bacnetWriteGroupService(Obj conn, Number groupNumber, Number writePriority, Number nListOfChannelValue, Bool? fInhibitDelay, Bool? inhibitDelay, Dict[] changeList)

-nListOfChannelValue: Specifies the number of BacnetGroupChannelValue objects in changelist
-fInhibitDelay: flag for optional inhibit-delay				
-inhibitDelay: This optional parameter shall specify whether Channel objects whose Allow_Group_Delay_Inhibit properties have a value of
              TRUE shall inhibit any execution delay specified in their Execution_Delay property. If the 'Inhibit Delay' parameter is absent
              or FALSE, then execution delay(s) shall occur according to the Execution_Delay property
-changeList: The list consists of (channel number, overridingPriority, value) tuples representing each channel number whose value is to be updated.
   channel number: Channel numbers shall range from 0 to 65535 where the channel number corresponds directly to the Channel_Number property of a Channel object
   overridingPriority: Allows specific values to be written with some priority other than that specified by Write_Priority property.
   BACnetChannelValue: Values that are any primitive application datatype or BACnetLightingCommand. The NULL value represents 'relinquish control' as with commandable .
                       object properties

Examples:

// Create an object

bacnetWriteGroupService(@connRef,2,1,5,true,true,[{"channel":0,"fOverridingPriority":true,"overridingPriority":15,"value": {"channelValue": 56,"type": 4}},

{"channel":1,"fOverridingPriority":true,"overridingPriority":15,"value": {"channelValue": 56,"type": 4}},
{"channel":2,"fOverridingPriority":true,"overridingPriority":15,"value": {"channelValue": 56,"type": 4}}, 
{"channel":3,"fOverridingPriority":true,"overridingPriority":15,"value": {"channelValue": 56,"type": 4}}, 
{"channel":4,"fOverridingPriority":true,"overridingPriority":15,"value": {"channelValue": 56,"type": 4}}])

bacnetWriteGroupService(@connRef,2,1,3,true,true,[{"channel":0,"fOverridingPriority":true,"overridingPriority":15,"value": {"channelValue": 56,"type": 4}},

{"channel":1,"fOverridingPriority":true,"overridingPriority":15,"value": {"channelValue": 56,"type": 4}}, 
{"channel":2,"fOverridingPriority":true,"overridingPriority":15,"value": {"channelValue": 56,"type": 4}}]

bacnetWriteNetworkPortProperty

@Axon { admin=true } static Grid bacnetWriteNetworkPortProperty(Obj prop, Obj? value, Bool? reinitStack := false, Number? index := null)

Update/Write property value in our own Stack data-base for supported properties from Device or Network-port Object

Parameters:
	- prop: integer or string value representing the object's property id
	- value: value to be written
	- reinitStack: By default this flag is false, hence after every successful execution of this query, stack will not restart.
				   If we wish to restart stack then pass true.
	- index: the integer index of the property to read, if the value of that property is an array.
	  Note - For Network-port objects when any property is written, stack initialization is must to apply those changes.
	  It acts as ReinitializeDevice service which re-boot the device to apply the changes.
	  Run bacnetApplyNetworkPortPendingChanges() query to apply network port changes if reinitStack false

Examples:
	bacnetWriteNetworkPortProperty(400, "192.168.245.1", true) - stack will restart
	bacnetWriteNetworkPortProperty("bacnet_ip_udp_port", 47808)
	bacnetWriteNetworkPortProperty("network-number", 65530)
	bacnetWriteNetworkPortProperty("ip_subnet_mask", "255.255.255.0")
	bacnetWriteNetworkPortProperty("network-number", 65530)
	bacnetWriteNetworkPortProperty(413, true)
	bacnetWriteNetworkPortProperty("Fd_Subscription_Lifetime", 1200)
	bacnetWriteNetworkPortProperty("bbmd_broadcast_distribution_table", [["192.168.25.1",47810,"255.255.255.0"],["192.168.253.111",47808,"255.255.255.0"]]) - BDT Enteries
	bacnetWriteNetworkPortProperty("Fd_Bbmd_Address", "192.168.250.11:47808")

bacnetWriteObjectProperty

@Axon { admin=true } static Grid bacnetWriteObjectProperty(Obj conn, Obj obj, Obj prop, Obj? value, Number? priority := Number.<ctor>(16), Number? index := null)

Write a BACnet property value

Parameters:

conn: the BACnet connection used to query the object properties
obj: either a BACnet point record or a point Ref, or a string formatted as bacnetCur, i.e. objectType:objectInstance. See bacnetCur for more details
prop: integer or string value representing the object property id
value: value to be written
priority: priority level, defaults to 16
index: property value index, default to null

Examples:

// Write the present value
bacnetWriteObjectProperty(@connRef, @pointRef, 85, 1.0)
bacnetWriteObjectProperty(@connRef, "AV1", "present_value", 1.0, 16)
bacnetWriteObjectProperty(@connRef,"2:1", 85, 1.0)
bacnetWriteObjectProperty(@connRef,"MSV1", "STATE_TEXT", "State_11", 16, 1)

bacnetWriteObjectProperty(@connRef, "BSV1","present_value",xstr("BitString","100100"))
bacnetWriteObjectProperty(@connRef, "DV1","present_value",xstr("Date","2014-01-01-*"))
bacnetWriteObjectProperty(@connRef, "OSV1","present_value",xstr("OctetString","100100"))
bacnetWriteObjectProperty(@connRef, "DTV1","present_value",xstr("DateTime","2023-01-03-02T12:20:32.00"), 10)

bacnetWritePropertyMultiple

@Axon { admin=true } static Grid bacnetWritePropertyMultiple(Obj conn, Dict objectPropDict)

Writes multiple object properties using the BACnet WritePropertyMultiple service if the remote device supports it. Accepts as parameters:

conn: the BACnet connection used to query the object properties
objectPropDict: a Dict with BACnet object Ids as keys and Dict of BACnet object properties as values The dict format is: {objectId1:{prop_name1:[propVal, propIndex, priority],prop_name2:[propVal]}, objectId2:{prop_name1:[propVal, propIndex]}}

Examples:

// Write present value and object name for 2 objects

bacnetWritePropertyMultiple(@connRef, {av1:{present_value:[100], object_name:["foo"]},
                                       av2:{present_value:[20, null, 8], object_name:["bar"]}})

bacnetWriteStackConfig

@Axon { admin=true } static Grid bacnetWriteStackConfig(Dict dictVal, Bool? reinitStackIfNeeded := true)

The method will write the Config key-value to /etc/bacnetExt/config.props file Dict : key-value pair of config values

Example:

bacnetWriteStackConfig({"bacnetRetryCount" :"4"}) bacnetWriteStackConfig({"actorTimeout" :"3000ms"}) bacnetWriteStackConfig({"actorTimeout" :"1min"}) bacnetWriteStackConfig({"bacnetInstance" :"1000"}) bacnetWriteStackConfig({"dnetNumber" :"10"}) bacnetWriteStackConfig({"serverPhysicalDnetNumber" :"1"}) bacnetWriteStackConfig({"serverPhysicalDnetNumber" :"1", "dnetNumber" :"10"}) bacnetWriteStackConfig({"serverPhysicalDnetNumber" :"1", "dnetNumber" :"10", "bacnetInstance": "123", "memoryFallbackRetryCount": "3"}) bacnetWriteStackConfig({"localBindAddress" :"0.0.0.0:47808", "libraryName" :"example_platform", "rtldLocal": "0", "rtldLazy": "1"}) bacnetWriteStackConfig({"logLevel" :"INFO", "logType": "JAVA"}) bacnetWriteStackConfig({"fHostnameEnabled" :"1"})

finSyncPointsInLib

@Axon static Void finSyncPointsInLib(List connIds, Number fromOrd, Number toOrd)

log

const static Log log := Log.get(BacnetLib#.name())

BacnetModel

@Js const class BacnetModel : ConnModel, FinWriteConnModel

Constructors


make

Fields


connProto

Methods


isCurSupported
isHisSupported
isLearnSupported
isPollingSupported
isWritePassThrough
isWriteSupported
pollingMode

Slot Details

connProto

virtual const override Dict connProto

isCurSupported

virtual override Bool isCurSupported()

isHisSupported

virtual override Bool isHisSupported()

isLearnSupported

virtual override Bool isLearnSupported()

isPollingSupported

virtual override Bool isPollingSupported()

isWritePassThrough

virtual override Bool isWritePassThrough(ConnImplExt ext, Dict rec)

isWriteSupported

virtual override Bool isWriteSupported()

make

new make()

pollingMode

virtual override PollingMode pollingMode()

BacnetObjId

const class BacnetObjId : Obj

Immutable wrapper class for a BACnet Object Id Used as key for the internal subscribed objects map

Constructors


make

Fields


instance
type

Methods


equals
hash
objectId
toStr

Slot Details

equals

virtual override Bool equals(Obj? other)

hash

virtual override Int hash()

instance

const Int instance

make

new make(BacStacObjectIdentifier objectId)

objectId

BacStacObjectIdentifier objectId()

toStr

virtual override Str toStr()

type

const Int type

BacnetUtils

class BacnetUtils : Obj

Fields


excludeTrendLogMarker
idsRefExpr
ipRegex
ipv4UdpPortRegex
isApplicationSoftwareRevisionSet
isFirmwareRevisionSet
log
namedRefExpr
portNumberRegex

Methods


addStackRouterEntry
bacnetObjectToPoint	Creates a point record for a given BACnet value object
bitStringToPointStatus
bitStringToStatuses
connName
createConfigFileIfNotExist
getBacnetExtConfig
getDnetNumber
getLocalBindAddress
getObjectValue	Get the "value" property from the BACnet valueObject and convert it to Fantom value suitable for the point.
getValueForProperty
getValueType
isPointStatusAvailable	get a BACnet point status
isValidBacStacPropertyIdentifier
openConn	Opens a BACnet connection for the given `connHandle` The caller should make sure that a valid <Context> is available, otherwise a `BacnetExt` instance parameter should be passed with `ext`
parseRef	parse `[type:instance]` pair from a ref string "type:instance (nameInstance)"
parseUri
pointDataGet
pointDataHas
pointDataRemove
pointDataSet
pointStatus	get a BACnet point status
readDeviceObjectList
readPoolSizeFromBbsConfig	Read pool parameters from BBS.conf
readValueFromDb	This method is called from bacnetLib This method is used to read property value from the stack database
setBacnetExtConfig
toBacnetUri
updateBbsConfigParamater	Update individual parameters in bbs.conf file.
updateNetworkPortProperty	This method is used to update the network-port property value in the bbs.conf file or stack DB.
updateProperty
uriToBacnetAddress
vendorId
vendorName

Slot Details

addStackRouterEntry

static Int addStackRouterEntry(Str ip, Int port, Int dNet)

bacnetObjectToPoint

static Str:Obj bacnetObjectToPoint(ValueObject obj, BacnetConn conn)

Creates a point record for a given BACnet value object

bitStringToPointStatus

static BACnetStatusFlags? bitStringToPointStatus(BacStacBitstring? statusFlags)

bitStringToStatuses

static BACnetStatusFlags[] bitStringToStatuses(BacStacBitstring? statusFlags)

connName

static Str? connName(BacnetConn conn)

createConfigFileIfNotExist

static Void createConfigFileIfNotExist()

excludeTrendLogMarker

const static Int excludeTrendLogMarker := 654321

getBacnetExtConfig

static Str? getBacnetExtConfig(Str key, Bool? ifNullDefault := true)

getDnetNumber

static Int? getDnetNumber()

getLocalBindAddress

static Str? getLocalBindAddress()

getObjectValue

static Obj? getObjectValue(ValueObject valObj, Dict pointRec)

Get the "value" property from the BACnet valueObject and convert it to Fantom value suitable for the point. PropId is only used if the ValueObject is Proprietary

getValueForProperty

static Obj? getValueForProperty(ValueObject valObj, Int? curValProperty, Int? index)

getValueType

static Str getValueType(BacStacObjectType objType)

idsRefExpr

const static Regex idsRefExpr := ...

ipRegex

const static Regex ipRegex := ...

ipv4UdpPortRegex

const static Regex ipv4UdpPortRegex := ...

isApplicationSoftwareRevisionSet

const static AtomicBool? isApplicationSoftwareRevisionSet := AtomicBool.<ctor>(false)

isFirmwareRevisionSet

const static AtomicBool? isFirmwareRevisionSet := AtomicBool.<ctor>(false)

isPointStatusAvailable

static Bool isPointStatusAvailable(ValueObject obj, BACnetStatusFlags statusFlagToCheck)

get a BACnet point status

isValidBacStacPropertyIdentifier

static BacStacPropertyIdentifier isValidBacStacPropertyIdentifier(Str propVal)

log

const static Log log := Log.get(BacnetUtils#.name())

namedRefExpr

const static Regex namedRefExpr := ...

openConn

static ClientConnection? openConn(Obj connHandler, BacnetExt ext := BacnetExt.cur())

Opens a BACnet connection for the given connHandle The caller should make sure that a valid <Context> is available, otherwise a BacnetExt instance parameter should be passed with ext

parseRef

static BacStacObjectIdentifier? parseRef(Obj? refObj)

parse [type:instance] pair from a ref string "type:instance (nameInstance)"

parseUri

static Str:Obj? parseUri(Uri uri)

pointDataGet

static Obj? pointDataGet(ConnPoint point, Str prop, Obj? def := null)

pointDataHas

static Bool pointDataHas(ConnPoint point, Str prop)

pointDataRemove

static Void pointDataRemove(ConnPoint point, Str prop)

pointDataSet

static Void pointDataSet(ConnPoint point, Str prop, Obj? val)

pointStatus

static BACnetStatusFlags? pointStatus(ValueObject obj)

get a BACnet point status

portNumberRegex

const static Regex portNumberRegex := ...

readDeviceObjectList

static Void readDeviceObjectList(ClientConnection conn, Log? log := null)

readPoolSizeFromBbsConfig

static Grid readPoolSizeFromBbsConfig()

Read pool parameters from BBS.conf

readValueFromDb

static Grid readValueFromDb(Dict rec, Number? prop, Number? index := null)

This method is called from bacnetLib This method is used to read property value from the stack database

@returns Grid in form of result consisting of property value.

setBacnetExtConfig

static Void setBacnetExtConfig(Str key, Str value)

toBacnetUri

static Uri toBacnetUri(Str:Obj? data)

updateBbsConfigParamater

static Int updateBbsConfigParamater(BacStacBbsConfFieldEnum configField, Obj? val)

Update individual parameters in bbs.conf file.

updateNetworkPortProperty

static Grid updateNetworkPortProperty(Dict rec, Number? prop, Obj? val, Number? index := null)

This method is used to update the network-port property value in the bbs.conf file or stack DB.

updateProperty

static Bool updateProperty(BacnetExt? ext, Str property, Obj dafaultValue, BacStacPropertyIdentifier deviceProperty)

uriToBacnetAddress

static BacnetAddress uriToBacnetAddress(Uri uri)

vendorId

static Int vendorId(BacnetConn bacnetConn)

vendorName

static Str vendorName(BacnetConn bacnetConn)

BacnetVirtualDevice

class BacnetVirtualDevice : Obj, IConnReceiveHandler

BacnetVirtualDevice Listens for remote devices requests

Each connector will be attached to a virtual device, so a group of connectors can share the same BACnet message handler because they could have the same Virtual Device instance.

Fields


local

Methods


create	Static factory to create a BacnetVirtualDevice based on the Device instance that the connection has
destroy
generateInstanceNumber
generateInstanceNumberUsingQuery
getDeviceInstanceNumber
getDnetNumber
hasAlarmHandler
hasCovHandler
processEventNotifications
processUnconfirmedCOVNotifications
recieved	Handles BACnet messages
registerAlarmHandler
registerCovHandler
removeAlarmHandler
removeCovHandler
updateDeviceObjectNameUsingQuery

Slot Details

create

static BacnetVirtualDevice create(BacnetConn conn)

Static factory to create a BacnetVirtualDevice based on the Device instance that the connection has

destroy

static Void destroy(BacnetConn conn, Dict rec := conn.rec())

generateInstanceNumber

static Int generateInstanceNumber(Proj? p := null)

generateInstanceNumberUsingQuery

static Int generateInstanceNumberUsingQuery(Number instanceNumber, Proj proj, Bool withConn)

getDeviceInstanceNumber

static Int getDeviceInstanceNumber(Proj? p := null)

getDnetNumber

static Int getDnetNumber()

hasAlarmHandler

Bool hasAlarmHandler(BacnetConn conn)

hasCovHandler

Bool hasCovHandler(BacnetConn conn)

local

const VirtualDevice local

processEventNotifications

Void processEventNotifications(ConfEventNotification eventData)

processUnconfirmedCOVNotifications

Void processUnconfirmedCOVNotifications(Notification confCOVData)

recieved

virtual override Void recieved(BacnetResponseMessage? message, BacnetAddress? address, BacnetAddress? recvAddress, BacnetSocket? conn)

Handles BACnet messages

registerAlarmHandler

Void registerAlarmHandler(BacnetConn conn, BacnetAlarmActor alarmActor)

registerCovHandler

Void registerCovHandler(BacnetConn conn, BacnetCOVActor covH)

removeAlarmHandler

Void removeAlarmHandler(BacnetConn conn)

removeCovHandler

Void removeCovHandler(BacnetConn conn)

updateDeviceObjectNameUsingQuery

static Str? updateDeviceObjectNameUsingQuery(Str objectName, Proj proj, Bool withConn)

BaseTypeConv

abstract class BaseTypeConv : Obj, ObjectConvert

Base BACnet type conversion, it register converters for all common properties

Each type will extend this and add its own properties

Constructors


make

Fields


objectPropsConverters
objectType

Methods


equals
hash
register
resolve
toBacnet
toHaystack

Slot Details

equals

virtual override Bool equals(Obj? that)

hash

virtual override Int hash()

make

new make(BacStacObjectType objectType)

objectPropsConverters

protected abstract Str:PropertyConverter objectPropsConverters

objectType

BacStacObjectType objectType

register

Void register(Str:ObjectConvert registry)

resolve

virtual override PropertyConverter? resolve(IBacStacPropertyIdentifier prop)

toBacnet

virtual override Obj? toBacnet(IBacStacPropertyIdentifier propId, Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(IBacStacPropertyIdentifier propId, Obj? bacnetValue)

BasicPropConverter

abstract const class BasicPropConverter : PrimitivesConverter, PropertyConverter

Implements the basic BACnet object properties using the primitive types converter

Methods


equals
hash
register

Slot Details

equals

virtual override Bool equals(Obj? that)

hash

virtual override Int hash()

register

Void register(Str:ValueConverter propConverters)

BdtConvert

const class BdtConvert : BasicPropConverter

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

BiasPropConvert

const class BiasPropConvert : BasicPropConverter

Implement a property converter for basic AckedTransitions property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

BinaryInputConvert

class BinaryInputConvert : BinaryObjectConvert

Constructors


make

Slot Details

make

new make()

BinaryLightingOutputConvert

class BinaryLightingOutputConvert : LightingOutputObjectConvert

Constructors


make

Slot Details

make

new make()

BinaryObjectConvert

abstract class BinaryObjectConvert : BaseTypeConv

Constructors


make

Fields


objectPropsConverters

Slot Details

make

new make(BacStacObjectType objectType)

objectPropsConverters

protected virtual override Str:PropertyConverter objectPropsConverters := [Str:PropertyConverter][:]

BinaryOutputConvert

class BinaryOutputConvert : BinaryObjectConvert

Constructors


make

Slot Details

make

new make()

BinaryValueConvert

class BinaryValueConvert : BinaryObjectConvert

Constructors


make

Slot Details

make

new make()

BitMaskPropConvert

const class BitMaskPropConvert : BasicPropConverter

Implement a property converter for basic Bit_Mask property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

BitStringAlarmValuesPropConvert

const class BitStringAlarmValuesPropConvert : BasicPropConverter

Implement a property converter for basic AlarmValues property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

BitStringPresentValuePropConvert

const class BitStringPresentValuePropConvert : BasicPropConverter

Implement a property converter for basic PresentValue property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

BitStringRelinquishDefaultPropConvert

const class BitStringRelinquishDefaultPropConvert : BasicPropConverter

Implement a property converter for basic RelinquishDefault property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

BitStringValueConvert

class BitStringValueConvert : BaseTypeConv

Constructors


make

Fields


objectPropsConverters

Slot Details

make

new make()

objectPropsConverters

protected virtual override Str:PropertyConverter objectPropsConverters := [Str:PropertyConverter][:]

BitTextPropConvert

const class BitTextPropConvert : BasicPropConverter

Implement a property converter for basic Bit_Text property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

BlinkWarnEnablePropConvert

const class BlinkWarnEnablePropConvert : BasicPropConverter

Implement a property converter for basic BlinkWarnEnable property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

BooleanMaintenanceRequiredPropConvert

const class BooleanMaintenanceRequiredPropConvert : BasicPropConverter

Implement a property converter for Boolean_Maintenance_Required property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

BooleanPresentValuePropConvert

const class BooleanPresentValuePropConvert : BasicPropConverter

Implement a property converter for PresentValue property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

BufferSizePropConvert

const class BufferSizePropConvert : BasicPropConverter

Implement a property converter for Buffer_Size property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

COVPeriodPropConvert

const class COVPeriodPropConvert : BasicPropConverter

Implement a property converter for basic COV_Period property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

COVResubscriptionIntervalPropConvert

const class COVResubscriptionIntervalPropConvert : BasicPropConverter

Being used by only TrendLog and GlobalGroup objects

Implement a property converter for basic COV_Resubscription_Interval property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

COVUPeriodPropConvert

const class COVUPeriodPropConvert : BasicPropConverter

Implement a property converter for basic COVU_Period property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

COVURecipientsPropConvert

const class COVURecipientsPropConvert : ComplexPropConverter

Implement a property converter for basic COVU_Recipients property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

CalendarConvert

class CalendarConvert : BaseTypeConv

Constructors


make

Fields


objectPropsConverters

Slot Details

make

new make()

objectPropsConverters

protected virtual override Str:PropertyConverter objectPropsConverters := [Str:PropertyConverter][:]

CalendarRec

class CalendarRec : ChronoRec

Constructors


make

Fields


chronos

Methods


children

Slot Details

children

virtual override DirtyRec[] children()

chronos

ChronoRec[] chronos := ChronoRec[,]

make

new make(ScheduleState state, Ref id, Dict? rec)

ChangeOfStateCountPropConvert

const class ChangeOfStateCountPropConvert : BasicPropConverter

Implement a property converter for Change_Of_State_Count property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ChangeOfStateTimePropConvert

const class ChangeOfStateTimePropConvert : BasicPropConverter

Implement a property converter for Change_Of_State_Time property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ChangesPendingConvert

const class ChangesPendingConvert : BasicPropConverter

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ChannelConvert

class ChannelConvert : BaseTypeConv

Constructors


make

Fields


objectPropsConverters

Slot Details

make

new make()

objectPropsConverters

protected virtual override Str:PropertyConverter objectPropsConverters := [Str:PropertyConverter][:]

ChannelNumberPropConvert

const class ChannelNumberPropConvert : BasicPropConverter

Implement a property converter for Number_Of_States property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ChannelValuePresentValuePropConvert

const class ChannelValuePresentValuePropConvert : ComplexPropConverter

Implement a property converter for Present_Value property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

CharacterStringPresentValuePropConvert

const class CharacterStringPresentValuePropConvert : BasicPropConverter

Implement a property converter for PresentValue property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

CharacterStringRelinquishDefaultPropConvert

const class CharacterStringRelinquishDefaultPropConvert : BasicPropConverter

Implement a property converter for RelinquishDefault property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

CharacterStringValueConvert

class CharacterStringValueConvert : BaseTypeConv

Constructors


make

Fields


objectPropsConverters

Slot Details

make

new make()

objectPropsConverters

protected virtual override Str:PropertyConverter objectPropsConverters := [Str:PropertyConverter][:]

ChronoRec

abstract class ChronoRec : DirtyRec

Constructors


make

Fields


calendar
dirty
id
rec
state

Methods


children

Slot Details

calendar

CalendarRec? calendar

children

abstract DirtyRec[] children()

dirty

virtual override Bool dirty

id

const Ref id

make

new make(ScheduleState state, Ref id, Dict? rec)

rec

Dict? rec

state

ScheduleState state

ClientCOVIncrementPropConvert

const class ClientCOVIncrementPropConvert : BasicPropConverter

Being used by only TrendLog and GlobalGroup objects

Implement a property converter for basic Client_COV_Increment property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

CommandConvert

class CommandConvert : BaseTypeConv

Constructors


make

Fields


objectPropsConverters

Slot Details

make

new make()

objectPropsConverters

protected virtual override Str:PropertyConverter objectPropsConverters := [Str:PropertyConverter][:]

ComplexConverter

const class ComplexConverter : PrimitivesConverter

Converts Complex Haystack to BACnet and vice-versa

Methods


createComplexDict
toBacnet	Covert Haystack complex to BACnet
toHaystack

Slot Details

createComplexDict

protected Dict createComplexDict(Obj value, Str type)

toBacnet

virtual override Obj? toBacnet(Obj? haystackVal)

Covert Haystack complex to BACnet

toHaystack

virtual override Obj? toHaystack(Obj? bacnetVal)

ComplexPropConverter

abstract const class ComplexPropConverter : ComplexConverter, PropertyConverter

Implements the complex BACnet object properties using the complex types converter

Methods


equals
hash
register

Slot Details

equals

virtual override Bool equals(Obj? that)

hash

virtual override Int hash()

register

Void register(Str:ValueConverter propConverters)

ConfigurationFilesPropConvert

const class ConfigurationFilesPropConvert : BasicPropConverter

Implement a property converter for Configuration_Files property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ControlGroupsPropConvert

const class ControlGroupsPropConvert : BasicPropConverter

Implement a property converter for Control_Groups property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ControlledVariableReferencePropConvert

const class ControlledVariableReferencePropConvert : BasicPropConverter

Implement a property converter for basic Controlled_Variable_Reference property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ControlledVariableUnitsPropConvert

const class ControlledVariableUnitsPropConvert : BasicPropConverter

Implement a property converter for Controlled_Variable_Units property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ControlledVariableValuePropConvert

const class ControlledVariableValuePropConvert : BasicPropConverter

Implement a property converter for Controlled_Variable_Value property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ConvertUtil

class ConvertUtil : Obj

Methods


getHaystackLabelByTag
getTagAndBacnetObject

Slot Details

getHaystackLabelByTag

static Str getHaystackLabelByTag(Int tag)

getTagAndBacnetObject

static Dict getTagAndBacnetObject(Dict tagAndValue)

CountBeforeChangePropConvert

const class CountBeforeChangePropConvert : BasicPropConverter

Implement a property converter for Count_Before_Change property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

CountChangeTimePropConvert

const class CountChangeTimePropConvert : BasicPropConverter

Implement a property converter for Count_Change_Time property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

CountPropConvert

const class CountPropConvert : BasicPropConverter

Implement a property converter for Count property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

CurrentCommandPriorityPropConvert

const class CurrentCommandPriorityPropConvert : BasicPropConverter

Implement a property converter for basic Current_Command_Priority property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DataValueError

const class DataValueError : Err

Error will be thrown when value for inquired property on device is error/failure in the choice of BACnet values

Constructors


make

Slot Details

make

new make()

DatabaseRevisionPropConvert

const class DatabaseRevisionPropConvert : BasicPropConverter

Implement a property converter for basic Database_Revision property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DateListPropConvert

const class DateListPropConvert : ComplexPropConverter

Implement a property converter for Date_List property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DatePatternValueConvert

class DatePatternValueConvert : BaseTypeConv

Constructors


make

Fields


objectPropsConverters

Slot Details

make

new make()

objectPropsConverters

protected virtual override Str:PropertyConverter objectPropsConverters := [Str:PropertyConverter][:]

DatePresentValuePropConvert

const class DatePresentValuePropConvert : BasicPropConverter

Implement a property converter for basic PresentValue property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DateRelinquishDefaultPropConvert

const class DateRelinquishDefaultPropConvert : BasicPropConverter

Implement a property converter for basic RelinquishDefault property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DateTimePatternValueConvert

class DateTimePatternValueConvert : DateTimeValueConvert

Constructors


make

Slot Details

make

new make()

DateTimePresentValuePropConvert

const class DateTimePresentValuePropConvert : BasicPropConverter

Implement a property converter for basic PresentValue property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DateTimeRelinquishDefaultPropConvert

const class DateTimeRelinquishDefaultPropConvert : BasicPropConverter

Implement a property converter for basic RelinquishDefault property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DateTimeValueConvert

class DateTimeValueConvert : BaseTypeConv

Constructors


make

Fields


objectPropsConverters

Slot Details

make

new make(BacStacObjectType objectType := ...)

objectPropsConverters

protected virtual override Str:PropertyConverter objectPropsConverters := [Str:PropertyConverter][:]

DateValueConvert

class DateValueConvert : BaseTypeConv

Constructors


make

Fields


objectPropsConverters

Slot Details

make

new make()

objectPropsConverters

protected virtual override Str:PropertyConverter objectPropsConverters := [Str:PropertyConverter][:]

DaylightSavingsStatusPropConvert

const class DaylightSavingsStatusPropConvert : BasicPropConverter

Implement a property converter for Daylight_Savings_Status property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DefaulFadeTimePropConvert

const class DefaulFadeTimePropConvert : BasicPropConverter

Implement a property converter for Default_Fade_Time property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DefaultProprietaryPropConvert

const class DefaultProprietaryPropConvert : BasicPropConverter

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DefaultRampRatePropConvert

const class DefaultRampRatePropConvert : BasicPropConverter

Implement a property converter for Default_Ramp_Rate property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DefaultStepIncrementPropConvert

const class DefaultStepIncrementPropConvert : BasicPropConverter

Implement a property converter for Default_Step_Increment property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DefaultTimeoutPropConvert

const class DefaultTimeoutPropConvert : BasicPropConverter

Implement a property converter for basic Default_Timeout property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DegradedObj

const class DegradedObj : Obj

Degraded to polling

Constructors


make

Fields


id
lastCovSubscribe

Slot Details

id

const BacnetObjId id

lastCovSubscribe

const Duration lastCovSubscribe

make

new make(BacnetObjId id)

DerivativeConstantPropConvert

const class DerivativeConstantPropConvert : BasicPropConverter

Implement a property converter for Derivative_Constant property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DerivativeConstantUnitsPropConvert

const class DerivativeConstantUnitsPropConvert : BasicPropConverter

Implement a property converter for Derivative_Constant_Units property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DescriptionOfHaltPropConvert

const class DescriptionOfHaltPropConvert : BasicPropConverter

Implement a property converter for basic Description_Of_Halt property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DescriptionPropConvert

const class DescriptionPropConvert : BasicPropConverter

Implement a property converter for basic Description property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DeviceAddressBindingPropConvert

const class DeviceAddressBindingPropConvert : ComplexPropConverter

Implement a property converter for basic UTC_Time_Synchronization_Recipients property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DeviceConvert

class DeviceConvert : BaseTypeConv

Constructors


make

Fields


objectPropsConverters

Slot Details

make

new make()

objectPropsConverters

protected virtual override Str:PropertyConverter objectPropsConverters := [Str:PropertyConverter][:]

DeviceModel

class DeviceModel : DiscoveryModelChange

Methods


addDevice
getDevices
updateDiscoveryInfo	update any extra info that was read during discovery set the info on the devices dictionaries

Slot Details

addDevice

virtual override Void addDevice(Obj?[]? items)

getDevices

virtual override Dict[] getDevices()

updateDiscoveryInfo

virtual override Void updateDiscoveryInfo()

update any extra info that was read during discovery set the info on the devices dictionaries

DeviceTypePropConvert

const class DeviceTypePropConvert : BasicPropConverter

Available for only BI, MSI, MSO, ACC and BO Implement a property converter for basic Device_Type property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DirectReadingPropConvert

const class DirectReadingPropConvert : BasicPropConverter

Implement a property converter for basic Direct_Reading property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DirtyRec

abstract class DirtyRec : Obj

Fields


dirty

Slot Details

dirty

virtual Bool dirty := true

DiscoveryModelChange

abstract class DiscoveryModelChange : Obj, IModelChange

Methods


addDevice
change
getDevices
updateDiscoveryInfo

Slot Details

addDevice

abstract Void addDevice(Obj?[]? items)

change

virtual override Void change([Object? items_$J)

getDevices

abstract Dict[] getDevices()

updateDiscoveryInfo

abstract Void updateDiscoveryInfo()

DoorAlarmStatusPropConvert

const class DoorAlarmStatusPropConvert : BasicPropConverter

Implement a property converter for basic Door_Alarm_Status property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DoorExtendedPulseTimePropConvert

const class DoorExtendedPulseTimePropConvert : BasicPropConverter

Implement a property converter for Door_Extended_Pulse_Time property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DoorMembersPropConvert

const class DoorMembersPropConvert : ComplexPropConverter

Implement a property converter for basic Door_Members property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DoorOpenTooLongTimePropConvert

const class DoorOpenTooLongTimePropConvert : BasicPropConverter

Implement a property converter for Door_Open_Too_Long_Time property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DoorPulseTimePropConvert

const class DoorPulseTimePropConvert : BasicPropConverter

Implement a property converter for Door_Pulse_Time property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DoorStatusPropConvert

const class DoorStatusPropConvert : BasicPropConverter

Implement a property converter for basic Door_Status property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DoorUnlockDelayTimePropConvert

const class DoorUnlockDelayTimePropConvert : BasicPropConverter

Implement a property converter for Door_Unlock_Delay_Time property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DoubleCOVIncrementPropConvert

const class DoubleCOVIncrementPropConvert : BasicPropConverter

Implement a property converter for basic AckedTransitions property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DoubleDeadbandPropConvert

const class DoubleDeadbandPropConvert : BasicPropConverter

Implement a property converter for Deadband property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DoubleFaultHighLimitPropConvert

const class DoubleFaultHighLimitPropConvert : BasicPropConverter

Implement a property converter for basic Fault_High_Limit property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DoubleFaultLowLimitPropConvert

const class DoubleFaultLowLimitPropConvert : BasicPropConverter

Implement a property converter for basic Fault_Low_Limit property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DoubleHighLimitPropConvert

const class DoubleHighLimitPropConvert : BasicPropConverter

Implement a property converter for basic High_Limit property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DoubleLowLimitPropConvert

const class DoubleLowLimitPropConvert : BasicPropConverter

Implement a property converter for basic Low_Limit property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DoubleMaxPresValuePropConvert

const class DoubleMaxPresValuePropConvert : BasicPropConverter

Implement a property converter for basic Max_Pres_Value property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DoubleMinPresValuePropConvert

const class DoubleMinPresValuePropConvert : BasicPropConverter

Implement a property converter for basic Min_Pres_Value property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DoublePresentValuePropConvert

const class DoublePresentValuePropConvert : BasicPropConverter

Implement a property converter for PresentValue property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DoubleRelinquishDefaultPropConvert

const class DoubleRelinquishDefaultPropConvert : BasicPropConverter

Implement a property converter for RelinquishDefault property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DoubleResolutionPropConvert

const class DoubleResolutionPropConvert : BasicPropConverter

Implement a property converter for basic Resolution property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

DutyWindowPropConvert

const class DutyWindowPropConvert : BasicPropConverter

Implement a property converter for basic Duty_Window property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EffectivePeriodPropConvert

const class EffectivePeriodPropConvert : ComplexPropConverter

Implement a property converter for Effective_Period property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EgressActivePropConvert

const class EgressActivePropConvert : BasicPropConverter

Implement a property converter for Egress_Active property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EgressTimePropConvert

const class EgressTimePropConvert : BasicPropConverter

Implement a property converter for Egress_Time property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ElapsedActiveTimePropConvert

const class ElapsedActiveTimePropConvert : BasicPropConverter

Implement a property converter for Elapsed_Active_Time property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EnablePropConvert

const class EnablePropConvert : BasicPropConverter

Available for only TL, TLM, LC and EL Implement a property converter for basic Enable property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EnumActionPropConvert

const class EnumActionPropConvert : BasicPropConverter

Implement a property converter for basic Action property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EnumAlarmValuesPropConvert

const class EnumAlarmValuesPropConvert : BasicPropConverter

Implement a property converter for basic AlarmValues property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EnumFaultValuesPropConvert

const class EnumFaultValuesPropConvert : BasicPropConverter

Implement a property converter for basic Fault_Values property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EnumFeedbackValuePropConvert

const class EnumFeedbackValuePropConvert : BasicPropConverter

Implement a property converter for FeedbackValue property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EnumMaintenanceRequiredPropConvert

const class EnumMaintenanceRequiredPropConvert : BasicPropConverter

Implement a property converter for Enum_Maintenance_Required property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EnumPresentValuePropConvert

const class EnumPresentValuePropConvert : BasicPropConverter

Implement a property converter for basic PresentValue property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EnumRelinquishDefaultPropConvert

const class EnumRelinquishDefaultPropConvert : BasicPropConverter

Implement a property converter for basic RelinquishDefault property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EnumTrackingValuePropConvert

const class EnumTrackingValuePropConvert : BasicPropConverter

Implement a property converter for Enum_Tracking_Value property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ErrorLimitPropConvert

const class ErrorLimitPropConvert : BasicPropConverter

Implement a property converter for Error_Limit property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EventAlgorithmInhibitPropConvert

const class EventAlgorithmInhibitPropConvert : BasicPropConverter

Implement a property converter for basic Event_Algorithm_Inhibit property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EventAlgorithmInhibitRefPropConvert

const class EventAlgorithmInhibitRefPropConvert : BasicPropConverter

Implement a property converter for basic Event_Algorithm_Inhibit_Ref property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EventDetectionEnablePropConvert

const class EventDetectionEnablePropConvert : BasicPropConverter

Implement a property converter for basic Event_Detection_Enable property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EventEnablePropConvert

const class EventEnablePropConvert : BasicPropConverter

Implement a property converter for basic Event_Enable property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EventEnrollmentConvert

class EventEnrollmentConvert : BaseTypeConv

Constructors


make

Fields


objectPropsConverters

Slot Details

make

new make()

objectPropsConverters

protected virtual override Str:PropertyConverter objectPropsConverters := [Str:PropertyConverter][:]

EventLogConvert

class EventLogConvert : LogObjectConvert

Constructors


make

Slot Details

make

new make()

EventLogRecordLogBufferPropConvert

const class EventLogRecordLogBufferPropConvert : ComplexPropConverter

Implement a property converter for basic Fault_Type property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EventMessageTextsConfigPropConvert

const class EventMessageTextsConfigPropConvert : BasicPropConverter

Implement a property converter for basic Event_Message_Texts_Config property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EventMessageTextsPropConvert

const class EventMessageTextsPropConvert : BasicPropConverter

Implement a property converter for basic Event_Message_Texts property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EventParametersPropConvert

const class EventParametersPropConvert : ComplexPropConverter

Implement a property converter for basic Event_Parameters property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EventStatePropConvert

const class EventStatePropConvert : BasicPropConverter

Implement a property converter for basic Event_State property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EventTimeStampPropConvert

const class EventTimeStampPropConvert : BasicPropConverter

Implement a property converter for basic Event_Time_Stamps property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

EventTypePropConvert

const class EventTypePropConvert : BasicPropConverter

Implement a property converter for basic Event_Type property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ExceptionSchedulePropConvert

const class ExceptionSchedulePropConvert : ComplexPropConverter

Implement a property converter for Exception_Schedule property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ExecutionDelayPropConvert

const class ExecutionDelayPropConvert : BasicPropConverter

Implement a property converter for Execution_Delay property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

ExpectedShedLevelPropConvert

const class ExpectedShedLevelPropConvert : ShedLevelDataConverter

Implement a property converter for basic Expected_Shed_Level property

Methods


propId

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

FaultParametersPropConvert

const class FaultParametersPropConvert : ComplexPropConverter

Implement a property converter for basic Fault_Parameters property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

FaultTypePropConvert

const class FaultTypePropConvert : BasicPropConverter

Implement a property converter for basic Fault_Type property

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

FdBbmdIpConvert

const class FdBbmdIpConvert : BasicPropConverter

Methods


propId
toBacnet
toHaystack

Slot Details

propId

virtual override BacStacPropertyIdentifier propId()

toBacnet

virtual override Obj? toBacnet(Obj? haystackValue)

toHaystack

virtual override Obj? toHaystack(Obj? bacnetValue)

bacnetExt 扩展参考 ​

目录（导读） ​

API 正文（英文） ​

errs ​

docs ​

Overview ​

Bacnet Connectors ​

Connector Points ​

Local device ​

APDUSegementTimeoutPropConvert ​

Slot Details ​

propId ​

toBacnet ​

toHaystack ​

APDUTimeoutPropConvert ​

Slot Details ​

propId ​

toBacnet ​

toHaystack ​

AcceptFdRegistrationsConvert ​

Slot Details ​

propId ​

toBacnet ​

toHaystack ​

AccessDoorConvert ​

Slot Details ​

make ​

objectPropsConverters ​

AccumulatorConvert ​

Slot Details ​

make ​

objectPropsConverters ​

AckedRequiredPropConvert ​

Slot Details ​

propId ​

toBacnet ​

toHaystack ​

AckedTransitionsPropConvert ​

Slot Details ​

propId ​

toBacnet ​

toHaystack ​

ActionPropConvert ​

Slot Details ​

propId ​

toBacnet ​

toHaystack ​

ActionTextPropConvert ​

Slot Details ​

propId ​

toBacnet ​

toHaystack ​

ActiveCOVSubscriptionsPropConvert ​

Slot Details ​

propId ​

toBacnet ​

toHaystack ​

ActiveTextPropConvert ​

Slot Details ​

propId ​

toBacnet ​

toHaystack ​

ActorState ​

Slot Details ​

actor ​

make ​

makeActor ​

makeActorCoalescing ​

receive ​

ActualShedLevelPropConvert ​

Slot Details ​

propId ​

AdjustValuePropConvert ​

Slot Details ​

propId ​

toBacnet ​

toHaystack ​

AlarmMsg ​

Slot Details ​

data ​

`bacnetExt` 扩展参考

目录（导读）

API 正文（英文）

errs

docs

Overview

Bacnet Connectors

Connector Points

Local device

APDUSegementTimeoutPropConvert

Slot Details

propId

toBacnet

toHaystack

APDUTimeoutPropConvert

Slot Details

propId

toBacnet

toHaystack

AcceptFdRegistrationsConvert

Slot Details

propId

toBacnet

toHaystack

AccessDoorConvert

Slot Details

make

objectPropsConverters

AccumulatorConvert

Slot Details

make

objectPropsConverters

AckedRequiredPropConvert

Slot Details

propId

toBacnet

toHaystack

AckedTransitionsPropConvert

Slot Details

propId

toBacnet

toHaystack

ActionPropConvert

Slot Details

propId

toBacnet

toHaystack

ActionTextPropConvert

Slot Details

propId

toBacnet

toHaystack

ActiveCOVSubscriptionsPropConvert

Slot Details

propId

toBacnet

toHaystack

ActiveTextPropConvert

Slot Details

propId

toBacnet

toHaystack

ActorState

Slot Details

actor

make

makeActor

makeActorCoalescing

receive

ActualShedLevelPropConvert

Slot Details

propId

AdjustValuePropConvert

Slot Details

propId

toBacnet

toHaystack

AlarmMsg

Slot Details

data