mirror of
https://github.com/JoelBender/bacpypes
synced 2025-10-27 00:57:47 +08:00
299 lines
12 KiB
Python
299 lines
12 KiB
Python
|
|
from bacpypes.object import Object, ReadableProperty, OptionalProperty
|
|
|
|
from bacpypes.primitivedata import Atomic, BitString, Boolean, CharacterString, Date, \
|
|
Double, Integer, ObjectIdentifier, ObjectType, OctetString, Real, Time, \
|
|
Unsigned, Tag, Enumerated, Null
|
|
|
|
from bacpypes.constructeddata import AnyAtomic, Array, ArrayOf, List, ListOf, \
|
|
Choice, Element, Sequence
|
|
|
|
from bacpypes.basetypes import AccessCredentialDisable, AccessCredentialDisableReason, \
|
|
AccessEvent, AccessPassbackMode, AccessRule, AccessThreatLevel, \
|
|
AccessUserType, AccessZoneOccupancyState, AccumulatorRecord, Action, \
|
|
ActionList, AddressBinding, AssignedAccessRights, AuthenticationFactor, \
|
|
AuthenticationFactorFormat, AuthenticationPolicy, AuthenticationStatus, \
|
|
AuthorizationException, AuthorizationMode, BackupState, BinaryPV, \
|
|
COVSubscription, CalendarEntry, ChannelValue, ClientCOV, \
|
|
CredentialAuthenticationFactor, DailySchedule, DateRange, DateTime, \
|
|
Destination, DeviceObjectPropertyReference, DeviceObjectReference, \
|
|
DeviceStatus, DoorAlarmState, DoorSecuredStatus, DoorStatus, DoorValue, \
|
|
EngineeringUnits, EventNotificationSubscription, EventParameter, \
|
|
EventState, EventTransitionBits, EventType, FaultParameter, FaultType, \
|
|
FileAccessMethod, LifeSafetyMode, LifeSafetyOperation, LifeSafetyState, \
|
|
LightingCommand, LightingInProgress, LightingTransition, LimitEnable, \
|
|
LockStatus, LogMultipleRecord, LogRecord, LogStatus, LoggingType, \
|
|
Maintenance, NetworkSecurityPolicy, NodeType, NotifyType, \
|
|
ObjectPropertyReference, ObjectTypesSupported, OptionalCharacterString, \
|
|
Polarity, PortPermission, Prescale, PriorityArray, ProcessIdSelection, \
|
|
ProgramError, ProgramRequest, ProgramState, PropertyAccessResult, \
|
|
PropertyIdentifier, Recipient, Reliability, RestartReason, Scale, \
|
|
SecurityKeySet, SecurityLevel, Segmentation, ServicesSupported, \
|
|
SetpointReference, ShedLevel, ShedState, SilencedState, SpecialEvent, \
|
|
StatusFlags, TimeStamp, VTClass, VTSession, WriteStatus
|
|
|
|
# TODO: add to objectIdentifier enumeration
|
|
# TODO: add to objectTypesSupported
|
|
# TODO: add new properties to propertyIdentifier
|
|
# TODO: fix property names
|
|
|
|
|
|
|
|
|
|
#
|
|
# NEW PRIMITIVES
|
|
#
|
|
|
|
class Unsigned8(Unsigned):
|
|
|
|
_app_tag = Tag.unsignedAppTag
|
|
|
|
def __init__(self,arg = None):
|
|
Unsigned.__init__(self, arg)
|
|
self.value = 0
|
|
|
|
if arg is None:
|
|
pass
|
|
elif isinstance(arg, Tag):
|
|
self.decode(arg)
|
|
elif isinstance(arg, int):
|
|
if not self.is_valid(arg):
|
|
raise ValueError("unsigned integer less than 256 required")
|
|
self.value = arg
|
|
elif isinstance(arg, Unsigned8):
|
|
self.value = arg.value
|
|
else:
|
|
raise TypeError("invalid constructor datatype")
|
|
|
|
|
|
@classmethod
|
|
def is_valid(cls, arg):
|
|
"""Return True if arg is valid value for the class."""
|
|
return Unsigned.is_valid(arg) and (0 <= arg <= 255)
|
|
|
|
def __str__(self):
|
|
return "%s(%s)" % (self.__class__.__name__, self.value)
|
|
|
|
|
|
class Unsigned16(Unsigned):
|
|
|
|
_app_tag = Tag.unsignedAppTag
|
|
|
|
def __init__(self,arg = None):
|
|
Unsigned.__init__(self, arg)
|
|
self.value = 0
|
|
|
|
if arg is None:
|
|
pass
|
|
elif isinstance(arg, Tag):
|
|
self.decode(arg)
|
|
elif isinstance(arg, int):
|
|
if not self.is_valid(arg):
|
|
raise ValueError("unsigned integer less than 65536 required")
|
|
self.value = arg
|
|
elif isinstance(arg, Unsigned16):
|
|
self.value = arg.value
|
|
else:
|
|
raise TypeError("invalid constructor datatype")
|
|
|
|
|
|
@classmethod
|
|
def is_valid(cls, arg):
|
|
"""Return True if arg is valid value for the class."""
|
|
return Unsigned.is_valid(arg) and (0 <= arg <= 65535)
|
|
|
|
def __str__(self):
|
|
return "%s(%s)" % (self.__class__.__name__, self.value)
|
|
|
|
#
|
|
# NEW BASETYPES
|
|
#
|
|
|
|
# Enumerations
|
|
|
|
class NetworkType(Enumerated):
|
|
enumerations = \
|
|
{ 'ethernet':0
|
|
, 'arcnet':1
|
|
, 'mstp':2
|
|
, 'ptp':3
|
|
, 'lontalk':4
|
|
, 'ipv4':5
|
|
, 'zigbee':6
|
|
, 'virtual': 7
|
|
# , 'non-bacnet': 8 Removed in Version 1, Revision 18
|
|
, 'ipv6':9
|
|
, 'serial':10
|
|
}
|
|
|
|
class ProtocolLevel(Enumerated):
|
|
enumerations = \
|
|
{ 'physical':0
|
|
, 'protocol':1
|
|
, 'bacnetApplication':2
|
|
, 'nonBacnetApplication':3
|
|
}
|
|
|
|
class NetworkNumberQuality(Enumerated):
|
|
enumerations = \
|
|
{ 'unknown':0
|
|
, 'learned':1
|
|
, 'learnedConfigured':2
|
|
, 'configured':3
|
|
}
|
|
|
|
class NetworkPortCommand(Enumerated):
|
|
enumerations = \
|
|
{ 'idle':0
|
|
, 'discardChanges':1
|
|
, 'renewFdDRegistration':2
|
|
, 'restartSlaveDiscovery':3
|
|
, 'renewDHCP':4
|
|
, 'restartAutonegotiation':5
|
|
, 'disconnect':6
|
|
, 'restartPort':7
|
|
}
|
|
|
|
class IPMode(Enumerated):
|
|
enumerations = \
|
|
{ 'normal':0
|
|
, 'foreign':1
|
|
, 'bbmd':2
|
|
}
|
|
|
|
class RouterEntryStatus(Enumerated):
|
|
# This was defined directly in the RouterEntry Sequence in the standard, but I moved it up here because
|
|
# I didn't see anywhere else you defined something that way.
|
|
enumerations = \
|
|
{ 'available':0
|
|
, 'busy':1
|
|
, 'disconnected':2
|
|
}
|
|
|
|
# Choices
|
|
|
|
class HostAddress(Choice):
|
|
choiceElements = \
|
|
[ Element('none', Null)
|
|
, Element('ipAddress', OctetString) # 4 octets for B/IP or 16 octets for B/IPv6
|
|
, Element('name', CharacterString) # Internet host name (see RFC 1123)
|
|
]
|
|
|
|
# Sequences
|
|
|
|
class HostNPort(Sequence):
|
|
sequenceElements = \
|
|
[ Element('host', HostAddress)
|
|
, Element('port', Unsigned16)
|
|
]
|
|
|
|
class BDTEntry(Sequence):
|
|
sequenceElements = \
|
|
[ Element('bbmdAddress', HostNPort)
|
|
, Element('broadcastMask', OctetString) # shall be present if BACnet/IP, and absent for BACnet/IPv6
|
|
]
|
|
|
|
class FDTEntry(Sequence):
|
|
sequenceElements = \
|
|
[ Element('bacnetIPAddress', OctetString) # the 6-octet B/IP or 18-octet B/IPv6 address of the registrant
|
|
, Element('timeToLive', Unsigned16) # time to live in seconds at the time of registration
|
|
, Element('remainingTimeToLive', Unsigned16) # remaining time to live in seconds, incl. grace period
|
|
]
|
|
|
|
class VMACEntry(Sequence):
|
|
sequenceElements = \
|
|
[ Element('virtualMACAddress', OctetString) # maximum size 6 octets
|
|
, Element('nativeMACAddress', OctetString)
|
|
]
|
|
|
|
class RouterEntry(Sequence):
|
|
sequenceElements = \
|
|
[ Element('networkNumber', Unsigned16)
|
|
, Element('macAddress', OctetString)
|
|
, Element('status', RouterEntryStatus) # Defined Above
|
|
]
|
|
|
|
class NameValue(Sequence):
|
|
sequenceElements = \
|
|
[ Element('name', CharacterString)
|
|
, Element('value', Atomic) # IS ATOMIC CORRECT HERE? value is limited to primitive datatypes and BACnetDateTime
|
|
]
|
|
|
|
#
|
|
# NEW OBJECT
|
|
#
|
|
|
|
class NetworkPortObject(Object):
|
|
objectType = 'NetworkPort' #56
|
|
properties = \
|
|
[ ReadableProperty('statusFlags', StatusFlags) #111
|
|
, ReadableProperty('reliability', Reliability) #103
|
|
, ReadableProperty('outOfService', Boolean) #81
|
|
, ReadableProperty('networkType', NetworkType) #427
|
|
, ReadableProperty('protocolLevel', ProtocolLevel) #482
|
|
, OptionalProperty('referencePort', Unsigned) #483
|
|
, ReadableProperty('networkNumber', Unsigned16) #425
|
|
, ReadableProperty('networkNumberQuality', NetworkNumberQuality) #427
|
|
, ReadableProperty('changesPending', Boolean) #416
|
|
, OptionalProperty('command', NetworkPortCommand) #417
|
|
, OptionalProperty('macAddress', OctetString) #423
|
|
, ReadableProperty('apduLength', Unsigned) #388
|
|
, ReadableProperty('linkSpeed', Real) #420
|
|
, OptionalProperty('linkSpeeds', ArrayOf(Real)) #421
|
|
, OptionalProperty('eventTimeStamps', ArrayOf(TimeStamp)) #130
|
|
, OptionalProperty('linkSpeedAutonegotiate', Boolean) #422
|
|
, OptionalProperty('networkInterfaceName', CharacterString) #424
|
|
, OptionalProperty('ipMode', IPMode) #408
|
|
, OptionalProperty('ipAddress', OctetString) #400
|
|
, OptionalProperty('ipUDPPort', Unsigned16) #412
|
|
, OptionalProperty('ipSubnetMask', OctetString) #411
|
|
, OptionalProperty('ipDefaultGateway', OctetString) #401
|
|
, OptionalProperty('ipMulticastAddress', OctetString) #409
|
|
, OptionalProperty('ipDNSServer', ArrayOf(OctetString)) #406
|
|
, OptionalProperty('ipDHCPEnable', Boolean) #402
|
|
, OptionalProperty('ipDHCPLeaseTime', Unsigned) #403
|
|
, OptionalProperty('ipDHCPLeaseTimeRemaining', Unsigned) #404
|
|
, OptionalProperty('ipDHCPServer', OctetString) #405
|
|
, OptionalProperty('ipNATTraversal', Boolean) #410
|
|
, OptionalProperty('ipGlobalAddress', HostNPort) #407
|
|
, OptionalProperty('broadcastDistributionTable', ListOf(BDTEntry)) #414
|
|
, OptionalProperty('acceptFDRegistrations', Boolean) #413
|
|
, OptionalProperty('bbmdForeignDeviceTable', ListOf(FDTEntry)) #415
|
|
, OptionalProperty('fdBBMDAddress', HostNPort) #418
|
|
, OptionalProperty('fdSubscriptionLifetime', Unsigned16) #419
|
|
, OptionalProperty('ipv6Mode', IPMode) #435
|
|
, OptionalProperty('ipv6Address', OctetString) #436
|
|
, OptionalProperty('ipv6PrefixLength', Unsigned8) #437
|
|
, OptionalProperty('ipv6UDPPort', Unsigned16) #438
|
|
, OptionalProperty('ipv6DefaultGateway', OctetString) #439
|
|
, OptionalProperty('ipv6MulticastAddress', OctetString) #440
|
|
, OptionalProperty('ipv6DNSServer', OctetString) #441
|
|
, OptionalProperty('ipv6AutoAddressingEnabled', Boolean) #442
|
|
, OptionalProperty('ipv6DHCPLeaseTime', Unsigned) #443
|
|
, OptionalProperty('ipv6DHCPLeaseTimeRemaining', Unsigned) #444
|
|
, OptionalProperty('ipv6DHCPServer', OctetString) #445
|
|
, OptionalProperty('ipv6ZoneIndex', CharacterString) #446
|
|
, OptionalProperty('maxMasters', Unsigned8) # range 0-127 #64
|
|
, OptionalProperty('maxInfoFrames', Unsigned8) #63
|
|
, OptionalProperty('slaveProxyEnable', Boolean) #172
|
|
, OptionalProperty('manualSlaveAddressBinding', ListOf(AddressBinding)) #170
|
|
, OptionalProperty('autoSlaveDiscovery', Boolean) #169
|
|
, OptionalProperty('slaveAddressBinding', ListOf(AddressBinding)) #171
|
|
, OptionalProperty('virtualMACAddressTable', ListOf(VMACEntry)) #429
|
|
, OptionalProperty('routingTable', ListOf(RouterEntry)) #428
|
|
, OptionalProperty('eventDetectionEnabled', Boolean) #353
|
|
, OptionalProperty('notificationClass', Unsigned) #17
|
|
, OptionalProperty('eventEnable', EventTransitionBits) #35
|
|
, OptionalProperty('ackedTransitions', EventTransitionBits) #0
|
|
, OptionalProperty('notifyType', NotifyType) #72
|
|
, OptionalProperty('eventTimeStamps', ArrayOf(TimeStamp, 3)) #130
|
|
, OptionalProperty('eventMessageTexts', ArrayOf(CharacterString, 3)) #351
|
|
, OptionalProperty('eventMessageTextsConfig', ArrayOf(CharacterString, 3)) #352
|
|
, OptionalProperty('eventState', EventState) #36
|
|
, ReadableProperty('reliabilityEvaluationInhibit', Boolean) #357
|
|
, OptionalProperty('propertyList', ArrayOf(PropertyIdentifier)) #371
|
|
, OptionalProperty('tags', ArrayOf(NameValue)) #486
|
|
, OptionalProperty('profileLocation', CharacterString) #91
|
|
, OptionalProperty('profileName', CharacterString) #168
|
|
]
|