Class default

To be able to communicate to BACNET devices, you have to initialize a new bacnet instance. BACnetClient

Example

import BACnetClient from "@bacnet-js/client";

const client = new BACnetClient({
  port: 47809,
  interface: '192.168.251.10',          // Listen on a specific interface
  broadcastAddress: '192.168.251.255',  // Use the subnet broadcast address
  apduTimeout: 6000                     // Wait twice as long for response
});

Hierarchy

TypedEventEmitter<BACnetClientEvents>
- default

Index

Constructors

constructor

Constructors

constructor

new default(options?: ClientOptions): default
Parameters
- Optionaloptions: ClientOptions
Returns default
Overrides TypedEventEmitter<BACnetClientEvents>.constructor
- Defined in client.ts:189

Methods

acknowledgeAlarm

acknowledgeAlarm(
    receiver: string | { address: string; forwardedFrom?: string },
    objectId: BACNetObjectID,
    eventState: number,
    ackText: string,
    evTimeStamp: BACNetTimestamp,
    ackTimeStamp: BACNetTimestamp,
    options: ServiceOptions | ErrorCallback,
    next?: ErrorCallback,
): void
Acknowledges an alarm.
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- objectId: BACNetObjectID
- eventState: number
- ackText: string
- evTimeStamp: BACNetTimestamp
- ackTimeStamp: BACNetTimestamp
- options: ServiceOptions | ErrorCallback
- Optionalnext: ErrorCallback
Returns void
- Defined in client.ts:2086

addListElement

addListElement(
    receiver: string | { address: string; forwardedFrom?: string },
    objectId: BACNetObjectID,
    reference: { id: number; index: number },
    values: BACNetAppData<ApplicationTag, any>[],
    options: ServiceOptions,
    next?: ErrorCallback,
): void
Adds an element to a list property
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- objectId: BACNetObjectID
- reference: { id: number; index: number }
- values: BACNetAppData<ApplicationTag, any>[]
- options: ServiceOptions
- Optionalnext: ErrorCallback
Returns void
- Defined in client.ts:1914

close

close(): void
Unloads the current bacnet instance and closes the underlying UDP socket.

Returns void
- Defined in client.ts:2568

confirmedCOVNotification

confirmedCOVNotification(
    receiver: AddressParameter,
    monitoredObject: BACNetObjectID,
    subscribeId: number,
    initiatingDeviceId: number,
    lifetime: number,
    values: {
        property: PropertyReference;
        value: TypedValue<ApplicationTag, any>[];
    }[],
    options: ServiceOptions | ErrorCallback,
    next?: ErrorCallback,
): void
The confirmedCOVNotification command is used to push notifications to other systems that have registered with us via a subscribeCov message.
Parameters
- receiver: AddressParameter
- monitoredObject: BACNetObjectID
- subscribeId: number
- initiatingDeviceId: number
- lifetime: number
- values: { property: PropertyReference; value: TypedValue<ApplicationTag, any>[] }[]
- options: ServiceOptions | ErrorCallback
- Optionalnext: ErrorCallback
Returns void
- Defined in client.ts:1250

confirmedEventNotification

confirmedEventNotification(
    receiver: string | { address: string; forwardedFrom?: string },
    eventNotification: any,
    options: ServiceOptions | ErrorCallback,
    next?: ErrorCallback,
): void
Sends a confirmed event notification.
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- eventNotification: any
- options: ServiceOptions | ErrorCallback
- Optionalnext: ErrorCallback
Returns void
- Defined in client.ts:2310

confirmedPrivateTransfer

confirmedPrivateTransfer(
    receiver: string | { address: string; forwardedFrom?: string },
    vendorId: number,
    serviceNumber: number,
    data: any,
    options: ServiceOptions | ErrorCallback,
    next?: ErrorCallback,
): void
Sends a confirmed private transfer.
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- vendorId: number
- serviceNumber: number
- data: any
- options: ServiceOptions | ErrorCallback
- Optionalnext: ErrorCallback
Returns void
- Defined in client.ts:2146

createObject

createObject(
    receiver: string | { address: string; forwardedFrom?: string },
    objectId: BACNetObjectID,
    values: {
        property: { id: number; index?: number };
        value: BACNetAppData<ApplicationTag, any>[];
    }[],
    options: ServiceOptions,
    next?: ErrorCallback,
): void
Creates a new object in a device
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- objectId: BACNetObjectID
- values: {
  property: { id: number; index?: number };
  value: BACNetAppData<ApplicationTag, any>[];
  }[]
- options: ServiceOptions
- Optionalnext: ErrorCallback
Returns void
- Defined in client.ts:1758

deleteObject

deleteObject(
    receiver: string | { address: string; forwardedFrom?: string },
    objectId: BACNetObjectID,
    options: ServiceOptions,
    next?: ErrorCallback,
): void
Deletes an object from a device
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- objectId: BACNetObjectID
- options: ServiceOptions
- Optionalnext: ErrorCallback
Returns void
- Defined in client.ts:1811

deviceCommunicationControl

deviceCommunicationControl(
    receiver: string | { address: string; forwardedFrom?: string },
    timeDuration: number,
    enableDisable: number,
    options: DeviceCommunicationOptions | ErrorCallback,
    next?: ErrorCallback,
): void
The deviceCommunicationControl command enables or disables network communication of the target device.
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- timeDuration: number
- enableDisable: number
- options: DeviceCommunicationOptions | ErrorCallback
- Optionalnext: ErrorCallback
Returns void
- Defined in client.ts:1315

emit

emit<TEvent extends keyof BACnetClientEvents>(
event: TEvent,
...args: Parameters<BACnetClientEvents[TEvent]>,
): boolean
Type Parameters
- TEvent extends keyof BACnetClientEvents
Parameters
- event: TEvent
- ...args: Parameters<BACnetClientEvents[TEvent]>
Returns boolean
Inherited from TypedEventEmitter.emit
- Defined in EventTypes.ts:254

errorResponse

errorResponse(
    receiver: string | { address?: string; forwardedFrom?: string },
    service: number,
    invokeId: number,
    errorClass: number,
    errorCode: number,
): void
Sends an error response.
Parameters
- receiver: string | { address?: string; forwardedFrom?: string }
- service: number
- invokeId: number
- errorClass: number
- errorCode: number
Returns void
- Defined in client.ts:2482

eventNames

eventNames(): (keyof BACnetClientEvents)[]
Returns (keyof BACnetClientEvents)[]
Inherited from TypedEventEmitter.eventNames
- Defined in EventTypes.ts:273

getAlarmSummary

getAlarmSummary(
    receiver: string | { address: string; forwardedFrom?: string },
    options: ServiceOptions | DataCallback<BACNetAlarm[]>,
    next?: DataCallback<BACNetAlarm[]>,
): void
Gets the alarm summary from a device.
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- options: ServiceOptions | DataCallback<BACNetAlarm[]>
- Optionalnext: DataCallback<BACNetAlarm[]>
Returns void
- Defined in client.ts:1971

getEnrollmentSummary

getEnrollmentSummary(
    receiver: string | { address: string; forwardedFrom?: string },
    acknowledgmentFilter: number,
    options:
        | DataCallback<any>
        | ServiceOptions & {
            enrollmentFilter?: any;
            eventStateFilter?: any;
            eventTypeFilter?: any;
            notificationClassFilter?: any;
            priorityFilter?: any;
        },
    next?: DataCallback<any>,
): void
Gets enrollment summary from a device.
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- acknowledgmentFilter: number
- options:
      | DataCallback<any>
      | ServiceOptions & {
          enrollmentFilter?: any;
          eventStateFilter?: any;
          eventTypeFilter?: any;
          notificationClassFilter?: any;
          priorityFilter?: any;
      }
- Optionalnext: DataCallback<any>
Returns void
- Defined in client.ts:2218

getEventInformation

getEventInformation(
    receiver: string | { address: string; forwardedFrom?: string },
    objectId: BACNetObjectID,
    options: ServiceOptions | DataCallback<BACNetEventInformation[]>,
    next?: DataCallback<BACNetEventInformation[]>,
): void
Gets event information from a device.
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- objectId: BACNetObjectID
- options: ServiceOptions | DataCallback<BACNetEventInformation[]>
- Optionalnext: DataCallback<BACNetEventInformation[]>
Returns void
- Defined in client.ts:2025

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from TypedEventEmitter.getMaxListeners
- Defined in EventTypes.ts:260

iAmResponse

iAmResponse(
    receiver: { address?: string; forwardedFrom?: string },
    deviceId: number,
    segmentation: number,
    vendorId: number,
): void
The iAmResponse command is sent as a reply to a whoIs request.
Parameters
- receiver: { address?: string; forwardedFrom?: string }
- deviceId: number
- segmentation: number
- vendorId: number
Returns void
- Defined in client.ts:2418

iHaveResponse

iHaveResponse(
    receiver: { address?: string; forwardedFrom?: string },
    deviceId: BACNetObjectID,
    objectId: BACNetObjectID,
    objectName: string,
): void
Sends an iHave response.
Parameters
- receiver: { address?: string; forwardedFrom?: string }
- deviceId: BACNetObjectID
- objectId: BACNetObjectID
- objectName: string
Returns void
- Defined in client.ts:2444

listenerCount

listenerCount<TEvent extends keyof BACnetClientEvents>(
event: TEvent,
listener?: BACnetClientEvents[TEvent],
): number
Type Parameters
- TEvent extends keyof BACnetClientEvents
Parameters
- event: TEvent
- Optionallistener: BACnetClientEvents[TEvent]
Returns number
Inherited from TypedEventEmitter.listenerCount
- Defined in EventTypes.ts:268

listeners

listeners<TEvent extends keyof BACnetClientEvents>(
eventName: TEvent,
): BACnetClientEvents[TEvent][]
Type Parameters
- TEvent extends keyof BACnetClientEvents
Parameters
- eventName: TEvent
Returns BACnetClientEvents[TEvent][]
Inherited from TypedEventEmitter.listeners
- Defined in EventTypes.ts:262

off

off<TEvent extends keyof BACnetClientEvents>(
event: TEvent,
callback: BACnetClientEvents[TEvent],
): this
Type Parameters
- TEvent extends keyof BACnetClientEvents
Parameters
- event: TEvent
- callback: BACnetClientEvents[TEvent]
Returns this
Inherited from TypedEventEmitter.off
- Defined in EventTypes.ts:247

on

on<TEvent extends keyof BACnetClientEvents>(
event: TEvent,
callback: BACnetClientEvents[TEvent],
): this
Type Parameters
- TEvent extends keyof BACnetClientEvents
Parameters
- event: TEvent
- callback: BACnetClientEvents[TEvent]
Returns this
Inherited from TypedEventEmitter.on
- Defined in EventTypes.ts:226

once

once<TEvent extends keyof BACnetClientEvents>(
event: TEvent,
callback: BACnetClientEvents[TEvent],
): this
Type Parameters
- TEvent extends keyof BACnetClientEvents
Parameters
- event: TEvent
- callback: BACnetClientEvents[TEvent]
Returns this
Inherited from TypedEventEmitter.once
- Defined in EventTypes.ts:230

prependListener

prependListener<TEvent extends keyof BACnetClientEvents>(
event: TEvent,
callback: BACnetClientEvents[TEvent],
): this
Type Parameters
- TEvent extends keyof BACnetClientEvents
Parameters
- event: TEvent
- callback: BACnetClientEvents[TEvent]
Returns this
Inherited from TypedEventEmitter.prependListener
- Defined in EventTypes.ts:234

prependOnceListener

prependOnceListener<TEvent extends keyof BACnetClientEvents>(
event: TEvent,
callback: BACnetClientEvents[TEvent],
): this
Type Parameters
- TEvent extends keyof BACnetClientEvents
Parameters
- event: TEvent
- callback: BACnetClientEvents[TEvent]
Returns this
Inherited from TypedEventEmitter.prependOnceListener
- Defined in EventTypes.ts:238

rawListeners

rawListeners<TEvent extends keyof BACnetClientEvents>(
eventName: TEvent,
): BACnetClientEvents[TEvent][]
Type Parameters
- TEvent extends keyof BACnetClientEvents
Parameters
- eventName: TEvent
Returns BACnetClientEvents[TEvent][]
Inherited from TypedEventEmitter.rawListeners
- Defined in EventTypes.ts:265

readFile

readFile(
    receiver: string | { address: string; forwardedFrom?: string },
    objectId: BACNetObjectID,
    position: number,
    count: number,
    options: ServiceOptions | DataCallback<DecodeAtomicReadFileResult>,
    next?: DataCallback<DecodeAtomicReadFileResult>,
): void
Reads a file from a remote device.
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- objectId: BACNetObjectID
- position: number
- count: number
- options: ServiceOptions | DataCallback<DecodeAtomicReadFileResult>
- Optionalnext: DataCallback<DecodeAtomicReadFileResult>
Returns void
- Defined in client.ts:1473

readProperty

readProperty(
    address: string,
    objectId: BACNetObjectID,
    propertyId: number,
    callback: DataCallback<DecodeAcknowledgeSingleResult>,
): void
The readProperty command reads a single property of an object from a device.
Parameters
- address: string
- objectId: BACNetObjectID
- propertyId: number
- callback: DataCallback<DecodeAcknowledgeSingleResult>
Returns void
- Defined in client.ts:941
readProperty(
    address: string,
    objectId: BACNetObjectID,
    propertyId: number,
    options: ReadPropertyOptions,
    callback: DataCallback<DecodeAcknowledgeSingleResult>,
): void
The readProperty command reads a single property of an object from a device.
Parameters
- address: string
- objectId: BACNetObjectID
- propertyId: number
- options: ReadPropertyOptions
- callback: DataCallback<DecodeAcknowledgeSingleResult>
Returns void
- Defined in client.ts:947

readPropertyMultiple

readPropertyMultiple(
    address: string,
    propertiesArray: BACNetReadAccessSpecification[],
    callback: DataCallback<DecodeAcknowledgeMultipleResult>,
): void
The readPropertyMultiple command reads multiple properties in multiple objects from a device.
Parameters
- address: string
- propertiesArray: BACNetReadAccessSpecification[]
- callback: DataCallback<DecodeAcknowledgeMultipleResult>
Returns void
- Defined in client.ts:1117
readPropertyMultiple(
    address: string,
    propertiesArray: BACNetReadAccessSpecification[],
    options: ServiceOptions,
    callback: DataCallback<DecodeAcknowledgeMultipleResult>,
): void
The readPropertyMultiple command reads multiple properties in multiple objects from a device.
Parameters
- address: string
- propertiesArray: BACNetReadAccessSpecification[]
- options: ServiceOptions
- callback: DataCallback<DecodeAcknowledgeMultipleResult>
Returns void
- Defined in client.ts:1122

readPropertyMultipleResponse

readPropertyMultipleResponse(
    receiver: string | { address: string; forwardedFrom?: string },
    invokeId: number,
    values: BACNetReadAccess[],
): void
Sends a response with information about multiple properties.
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- invokeId: number
- values: BACNetReadAccess[]
Returns void
- Defined in client.ts:2394

readPropertyResponse

readPropertyResponse(
    receiver: string | { address: string; forwardedFrom?: string },
    invokeId: number,
    objectId: BACNetObjectID,
    property: BACNetPropertyID,
    value:
        | BACNetAppData<ApplicationTag, any>
        | BACNetAppData<ApplicationTag, any>[],
    options?: { forwardedFrom?: string },
): void
The readPropertyResponse call sends a response with information about one of our properties.
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- invokeId: number
- objectId: BACNetObjectID
- property: BACNetPropertyID
- value: BACNetAppData<ApplicationTag, any> | BACNetAppData<ApplicationTag, any>[]
- options: { forwardedFrom?: string } = {}
Returns void
- Defined in client.ts:2358

readRange

readRange(
    receiver: string | { address: string; forwardedFrom?: string },
    objectId: BACNetObjectID,
    idxBegin: number,
    quantity: number,
    options: ServiceOptions | DataCallback<any>,
    next?: DataCallback<any>,
): void
Reads a range of data from a remote device.
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- objectId: BACNetObjectID
- idxBegin: number
- quantity: number
- options: ServiceOptions | DataCallback<any>
- Optionalnext: DataCallback<any>
Returns void
- Defined in client.ts:1530

reinitializeDevice

reinitializeDevice(
    receiver: string | { address: string; forwardedFrom?: string },
    state: number,
    options: ReinitializeDeviceOptions | ErrorCallback,
    next?: ErrorCallback,
): void
The reinitializeDevice command initiates a restart of the target device.
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- state: number
- options: ReinitializeDeviceOptions | ErrorCallback
- Optionalnext: ErrorCallback
Returns void
- Defined in client.ts:1368

removeAllListeners

removeAllListeners(event?: keyof BACnetClientEvents): this
Parameters
- Optionalevent: keyof BACnetClientEvents
Returns this
Inherited from TypedEventEmitter.removeAllListeners
- Defined in EventTypes.ts:252

removeListElement

removeListElement(
    receiver: string | { address: string; forwardedFrom?: string },
    objectId: BACNetObjectID,
    reference: { id: number; index: number },
    values: BACNetAppData<ApplicationTag, any>[],
    options: ServiceOptions,
    next?: ErrorCallback,
): void
Removes an element from a list property
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- objectId: BACNetObjectID
- reference: { id: number; index: number }
- values: BACNetAppData<ApplicationTag, any>[]
- options: ServiceOptions
- Optionalnext: ErrorCallback
Returns void
- Defined in client.ts:1857

removeListener

removeListener<TEvent extends keyof BACnetClientEvents>(
event: TEvent,
callback: BACnetClientEvents[TEvent],
): this
Type Parameters
- TEvent extends keyof BACnetClientEvents
Parameters
- event: TEvent
- callback: BACnetClientEvents[TEvent]
Returns this
Inherited from TypedEventEmitter.removeListener
- Defined in EventTypes.ts:243

resultResponse

resultResponse(receiver: { address: string }, resultCode: number): void
The resultResponse is a BVLC-Result message used to respond to certain events, such as BBMD registration. This message cannot be wrapped for passing through a BBMD, as it is used as a BBMD control message.
Parameters
- receiver: { address: string }
- resultCode: number
Returns void
- Defined in client.ts:2554

sendBvlc

sendBvlc(
receiver: string | { address?: string; forwardedFrom?: string },
buffer: EncodeBuffer,
): void
Sends a BACnet Virtual Link Control message.
Parameters
- receiver: string | { address?: string; forwardedFrom?: string }
- buffer: EncodeBuffer
Returns void
- Defined in client.ts:2509

setMaxListeners

setMaxListeners(n: number): this
Parameters
- n: number
Returns this
Inherited from TypedEventEmitter.setMaxListeners
- Defined in EventTypes.ts:259

simpleAckResponse

simpleAckResponse(
    receiver: string | { address?: string; forwardedFrom?: string },
    service: number,
    invokeId: number,
): void
Sends a simple acknowledgement response.
Parameters
- receiver: string | { address?: string; forwardedFrom?: string }
- service: number
- invokeId: number
Returns void
- Defined in client.ts:2464

subscribeCov

subscribeCov(
    receiver: string | { address: string; forwardedFrom?: string },
    objectId: BACNetObjectID,
    subscribeId: number,
    cancel: boolean,
    issueConfirmedNotifications: boolean,
    lifetime: number,
    options: ServiceOptions,
    next?: ErrorCallback,
): void
Subscribes to Change of Value (COV) notifications for an object
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- objectId: BACNetObjectID
- subscribeId: number
- cancel: boolean
- issueConfirmedNotifications: boolean
- lifetime: number
- options: ServiceOptions
- Optionalnext: ErrorCallback
Returns void
- Defined in client.ts:1597

subscribeProperty

subscribeProperty(
    receiver: string | { address: string; forwardedFrom?: string },
    objectId: BACNetObjectID,
    monitoredProperty: BACNetPropertyID,
    subscribeId: number,
    cancel: boolean,
    issueConfirmedNotifications: boolean,
    options: ServiceOptions,
    next?: ErrorCallback,
): void
Subscribes to Change of Value (COV) notifications for a specific property
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- objectId: BACNetObjectID
- monitoredProperty: BACNetPropertyID
- subscribeId: number
- cancel: boolean
- issueConfirmedNotifications: boolean
- options: ServiceOptions
- Optionalnext: ErrorCallback
Returns void
- Defined in client.ts:1654

timeSync

timeSync(receiver: AddressParameter, dateTime: Date): void
The timeSync command sets the time of a target device.
Parameters
- receiver: AddressParameter
- dateTime: Date
Returns void
- Defined in client.ts:907

timeSyncUTC

timeSyncUTC(receiver: AddressParameter, dateTime: Date): void
The timeSyncUTC command sets the UTC time of a target device.
Parameters
- receiver: AddressParameter
- dateTime: Date
Returns void
- Defined in client.ts:924

unconfirmedCOVNotification

unconfirmedCOVNotification(
    receiver: string | { address: string },
    subscriberProcessId: number,
    initiatingDeviceId: number,
    monitoredObjectId: BACNetObjectID,
    timeRemaining: number,
    values: {
        property: { id: number; index?: number };
        value: BACNetAppData<ApplicationTag, any>[];
    }[],
): void
Sends an unconfirmed COV notification to a device
Parameters
- receiver: string | { address: string }
- subscriberProcessId: number
- initiatingDeviceId: number
- monitoredObjectId: BACNetObjectID
- timeRemaining: number
- values: {
  property: { id: number; index?: number };
  value: BACNetAppData<ApplicationTag, any>[];
  }[]
Returns void
- Defined in client.ts:1714

unconfirmedEventNotification

unconfirmedEventNotification(
receiver: string | { address: string; forwardedFrom?: string },
eventNotification: any,
): void
Sends an unconfirmed event notification.
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- eventNotification: any
Returns void
- Defined in client.ts:2290

unconfirmedPrivateTransfer

unconfirmedPrivateTransfer(
    receiver: string | { address: string; forwardedFrom?: string },
    vendorId: number,
    serviceNumber: number,
    data: any,
): void
Sends an unconfirmed private transfer.
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- vendorId: number
- serviceNumber: number
- data: any
Returns void
- Defined in client.ts:2196

whoIs

whoIs(
    receiver?:
        | string
        | {
            address?: string;
            forwardedFrom?: string;
            highLimit?: number;
            lowLimit?: number;
        },
    options?: WhoIsOptions,
): void
The whoIs command discovers all BACNET devices in a network.
Parameters
- Optionalreceiver:
      | string
      | {
          address?: string;
          forwardedFrom?: string;
          highLimit?: number;
          lowLimit?: number;
      }
- Optionaloptions: WhoIsOptions
Returns void
Fires
BACnetClient.iAm
- Defined in client.ts:846

writeFile

writeFile(
    receiver: string | { address: string; forwardedFrom?: string },
    objectId: BACNetObjectID,
    position: number,
    fileBuffer: number[][],
    options: ServiceOptions | DataCallback<DecodeAtomicWriteFileResult>,
    next?: DataCallback<DecodeAtomicWriteFileResult>,
): void
Writes a file to a remote device.
Parameters
- receiver: string | { address: string; forwardedFrom?: string }
- objectId: BACNetObjectID
- position: number
- fileBuffer: number[][]
- options: ServiceOptions | DataCallback<DecodeAtomicWriteFileResult>
- Optionalnext: DataCallback<DecodeAtomicWriteFileResult>
Returns void
- Defined in client.ts:1415

writeProperty

writeProperty(
    address: string,
    objectId: BACNetObjectID,
    propertyId: number,
    values: BACNetAppData<ApplicationTag, any>[],
    options: WritePropertyOptions,
    callback: ErrorCallback,
): void
The writeProperty command writes a single property of an object to a device.
Parameters
- address: string
- objectId: BACNetObjectID
- propertyId: number
- values: BACNetAppData<ApplicationTag, any>[]
- options: WritePropertyOptions
- callback: ErrorCallback
Returns void
- Defined in client.ts:1041

writePropertyMultiple

writePropertyMultiple(
    address: string,
    values: WritePropertyMultipleObject[],
    callback: ErrorCallback,
): void
The writePropertyMultiple command writes multiple properties in multiple objects to a device.
Parameters
- address: string
- values: WritePropertyMultipleObject[]
- callback: ErrorCallback
Returns void
- Defined in client.ts:1195
writePropertyMultiple(
    address: string,
    values: WritePropertyMultipleObject[],
    options: ServiceOptions,
    callback: ErrorCallback,
): void
The writePropertyMultiple command writes multiple properties in multiple objects to a device.
Parameters
- address: string
- values: WritePropertyMultipleObject[]
- options: ServiceOptions
- callback: ErrorCallback
Returns void
- Defined in client.ts:1200

`Static`createBitstring

createBitstring(items: number[]): BACNetBitString
Helper function to take an array of enums and produce a bitstring suitable for inclusion as a property.
Parameters
- items: number[]
Returns BACNetBitString
BACnet bitstring object
- Defined in client.ts:2577

Class default

Example

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns default

Methods

acknowledgeAlarm

Parameters

Returns void

addListElement

Parameters

Returns void

close

Returns void

confirmedCOVNotification

Parameters

Returns void

confirmedEventNotification

Parameters

Returns void

confirmedPrivateTransfer

Parameters

Returns void

createObject

Parameters

Returns void

deleteObject

Parameters

Returns void

deviceCommunicationControl

Parameters

Returns void

emit

Type Parameters

Parameters

Returns boolean

errorResponse

Parameters

Returns void

eventNames

Returns (keyof BACnetClientEvents)[]

getAlarmSummary

Parameters

Returns void

getEnrollmentSummary

Parameters

Returns void

getEventInformation

Parameters

Returns void

getMaxListeners

Returns number

iAmResponse

Parameters

Returns void

iHaveResponse

Parameters

Returns void

listenerCount

Type Parameters

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns BACnetClientEvents[TEvent][]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once