Read proprietary property

[hvdort]

I try to readout our building management system based on BACnet. On this moment, I can readout the mandatory properties using python and BAC0.

How can I readout a proprietary property? We have Priva Blue ID systems, and Priva use standard an own property for description: 10502. (The vendor-id = 105). This field is simply filled with a text-string.

For example (anonymized) manually:

$ python3 -m asyncio
asyncio REPL 3.11.11 (main, Dec  9 2024, 15:32:27) [GCC 8.5.0 20210514 (Red Hat 8.5.0-22)] on linux
Use "await" directly instead of "asyncio.run()".
Type "help", "copyright", "credits" or "license" for more information.
>>> import asyncio
>>> import BAC0
>>> bacnet = BAC0.lite(ip="<blueidcontrollerip>/24") #
2025-03-03 09:07:53,727 - INFO    | Starting Asynchronous BAC0 version 2024.09.10 (Lite)
2025-03-03 09:07:53,727 - INFO    | Using bacpypes3 version 0.0.99
2025-03-03 09:07:53,727 - INFO    | Use BAC0.log_level to adjust verbosity of the app.
2025-03-03 09:07:53,727 - INFO    | Ex. BAC0.log_level('silence') or BAC0.log_level('error')
2025-03-03 09:07:53,756 - INFO    | Using ip : xxxxxx/24 on port 47808 | broadcast : xxxxx.255
2025-03-03 09:07:53,773 - INFO    | Using default JSON configuration file
2025-03-03 09:07:53,786 - INFO    | Registered as BACnet/IP App | mode normal
2025-03-03 09:07:53,789 - INFO    | Device instance (id) : 3056465
2025-03-03 09:07:53,789 - INFO    | Installing recurring task Ping Task (id:140705762553296)
>>>
>>> await bacnet.readMultiple("20100:0xc90000000000 0 70 all",show_property_name=True)
[((<ObjectType: analog-input>, 70), <PropertyIdentifier: object-identifier>), (<ObjectType: analog-input>, <PropertyIdentifier: object-type>), ('93TT3 AI - 70', <PropertyIdentifier: object-name>), ('Ruimtetemperatuur MER', <PropertyIdentifier: description>), (20.600000381469727, <PropertyIdentifier: present-value>), (<StatusFlags: >, <PropertyIdentifier: status-flags>), (<EventState: normal>, <PropertyIdentifier: event-state>), (<EngineeringUnits: degrees-celsius>, <PropertyIdentifier: units>), (<Reliability: no-fault-detected>, <PropertyIdentifier: reliability>), (0.10000000149011612, <PropertyIdentifier: cov-increment>), (None, <PropertyIdentifier: 10502>), (0, <PropertyIdentifier: out-of-service>)]
>>>

.... (None, <PropertyIdentifier: 10502>), .....

You see "None" for this property, but if I readout this with Yabe, I see:

How can I readout this property?

[ChristianTremblay]

Dealing with Proprietary objects in BAC0 (in fact, with BACpypes3) requires some work. The library needs to know in advance, what kind of "type" the property is.

Some guess work can be done when reading... but to write to those properties, you got to be certain.

For now, the way I understood BACpypes3, I haven't looked too deep in the "guess the type path" and I adopted the explicit way of defining proprietary objects and properties. This way, we can safely read and write those.

For your convenience, I added one attempt to define the proprietary objects for priva blue contollers here :
https://github.com/ChristianTremblay/BAC0/blob/develop/BAC0/core/proprietary_objects/privablue_105.py

Here is an example on how I use this principle with Johnson Controls devices

# trying to read property 32527 of Device Object
await bacnet.read('3:6 device:5206 32527')

RuntimeWarning: Enable tracemalloc to get the object allocation traceback
'-no property type-'

I need to import the file so BAC0 "knows" about the proprietary objects and properties

import BAC0.core.proprietary_objects.jci_5
>>> await bacnet.read('3:6 device:5206 32527', vendor_id=5) 
'8-1'
>>> await bacnet.read('3:6 device:5206 32527')              
'8-1'

I may or not provide the vendor ID

By using this file, BAC0 knows the type, so it's also possible to write to the properties when allowed.

[hvdort]

excellent! It works at the first trial. Many thanks!

[OGS-SOCOMEC]

Hi,
I have encountered the same need as @hvdort but in my case for Socomec metering products and proprietary properties on analogInputs, and the explanation given by @ChristianTremblay seems clear to me.
I too have created a soco_591.py file (591 is the vendor ID) in my repo .../BAC0/core/proprietary_objects based on the templates given for jci or privablue. Below is a very simplified version for the example:

"""
# Register Socomec Proprietary Objects and properties
"""

from bacpypes3.vendor import VendorInfo, get_vendor_info
from bacpypes3.basetypes import OptionalUnsigned, PropertyIdentifier
from bacpypes3.debugging import ModuleLogger
from bacpypes3.object import AnalogInputObject as _AnalogInputObject
from bacpypes3.object import NetworkPortObject as _NetworkPortObject
from bacpypes3.primitivedata import Boolean  # Signed,
from bacpypes3.primitivedata import (
    CharacterString,
    Date,
    Enumerated,
    ObjectType,
    Real,
    Time,
    Unsigned,
)

# some debugging
_debug = 0
_log = ModuleLogger(globals())


# this vendor identifier reference is used when registering custom classes
_vendor_id = 591
_vendor_name = "Socomec"


class ProprietaryObjectType(ObjectType):
    pass


class ProprietaryPropertyIdentifier(PropertyIdentifier):
    instantaneous_timestamp = 4100

try:
    _soco = VendorInfo(_vendor_id, ProprietaryObjectType, ProprietaryPropertyIdentifier)
except RuntimeError:
    pass  # we are re-running the script...
    _soco = get_vendor_info(_vendor_id)


class SocoDeviceObject(_DeviceObject):
    pass


class SocoAnalogInputObject(_AnalogInputObject):
    instantaneous_timestamp: Real

However, I still get the ‘-no property type-’ error when trying to read my property:

import BAC0.core.proprietary_objects.soco_591
result = await bacnet.read('6000:0x177d analogInput 164 4100', vendor_id=591)

So I'm wondering whether I need to do something else for BAC0 to take it into account? I read in the lib documentation (https://bac0.readthedocs.io/en/latest/proprietary_objects.html) something about a create_proprietaryobject function to call but it doesn't seem to exist in BAC0 2025.2.post18...
I specify that I can read the ‘classic’ BacNet properties (77 for the object name for example) on this same analogInput with instance 164...

Thanks in advance !

[ChristianTremblay]

you need to import your class