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:193

Methods

acknowledgeAlarm

acknowledgeAlarm(
    receiver: BACNetAddress,
    objectId: BACNetObjectID,
    eventState: number,
    ackText: string,
    evTimeStamp: BACNetTimestamp,
    ackTimeStamp: BACNetTimestamp,
    options?: ServiceOptions,
): Promise<void>
Acknowledges an alarm.
Parameters
- receiver: BACNetAddress
- objectId: BACNetObjectID
- eventState: number
- ackText: string
- evTimeStamp: BACNetTimestamp
- ackTimeStamp: BACNetTimestamp
- options: ServiceOptions = {}
Returns Promise<void>
- Defined in client.ts:1830

addListElement

addListElement(
    receiver: BACNetAddress,
    objectId: BACNetObjectID,
    reference: { id: number; index: number },
    values: BACNetAppData<ApplicationTag, any>[],
    options?: ServiceOptions,
): Promise<void>
Adds an element to a list property
Parameters
- receiver: BACNetAddress
- objectId: BACNetObjectID
- reference: { id: number; index: number }
- values: BACNetAppData<ApplicationTag, any>[]
- options: ServiceOptions = {}
Returns Promise<void>
- Defined in client.ts:1686

close

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

Returns void
- Defined in client.ts:2231

confirmedCOVNotification

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

confirmedEventNotification

confirmedEventNotification(
    receiver: BACNetAddress,
    eventNotification: EventNotifyDataParams,
    options?: ServiceOptions,
): Promise<void>
Sends a confirmed event notification.
Parameters
- receiver: BACNetAddress
- eventNotification: EventNotifyDataParams
- options: ServiceOptions = {}
Returns Promise<void>
- Defined in client.ts:2011

confirmedPrivateTransfer

confirmedPrivateTransfer(
    receiver: BACNetAddress,
    vendorId: number,
    serviceNumber: number,
    data: number[],
    options?: ServiceOptions,
): Promise<void>
Sends a confirmed private transfer.
Parameters
- receiver: BACNetAddress
- vendorId: number
- serviceNumber: number
- data: number[]
- options: ServiceOptions = {}
Returns Promise<void>
- Defined in client.ts:1881

createObject

createObject(
    receiver: BACNetAddress,
    objectId: BACNetObjectID,
    values: {
        property: { id: number; index?: number };
        value: BACNetAppData<ApplicationTag, any>[];
    }[],
    options?: ServiceOptions,
): Promise<void>
Creates a new object in a device
Parameters
- receiver: BACNetAddress
- objectId: BACNetObjectID
- values: {
  property: { id: number; index?: number };
  value: BACNetAppData<ApplicationTag, any>[];
  }[]
- options: ServiceOptions = {}
Returns Promise<void>
- Defined in client.ts:1566

deleteObject

deleteObject(
    receiver: BACNetAddress,
    objectId: BACNetObjectID,
    options?: ServiceOptions,
): Promise<void>
Deletes an object from a device
Parameters
- receiver: BACNetAddress
- objectId: BACNetObjectID
- options: ServiceOptions = {}
Returns Promise<void>
- Defined in client.ts:1607

deviceCommunicationControl

deviceCommunicationControl(
    receiver: BACNetAddress,
    timeDuration: number,
    enableDisable: number,
    options?: DeviceCommunicationOptions,
): Promise<void>
The deviceCommunicationControl command enables or disables network communication of the target device.
Parameters
- receiver: BACNetAddress
- timeDuration: number
- enableDisable: number
- options: DeviceCommunicationOptions = {}
Returns Promise<void>
- Defined in client.ts:1187

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: BACNetAddress,
    service: number,
    invokeId: number,
    errorClass: number,
    errorCode: number,
): void
Sends an error response.
Parameters
- receiver: BACNetAddress
- service: number
- invokeId: number
- errorClass: number
- errorCode: number
Returns void
- Defined in client.ts:2162

eventNames

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

getAlarmSummary

getAlarmSummary(
receiver: BACNetAddress,
options?: ServiceOptions,
): Promise<BACNetAlarm[]>
Gets the alarm summary from a device.
Parameters
- receiver: BACNetAddress
- options: ServiceOptions = {}
Returns Promise<BACNetAlarm[]>
- Defined in client.ts:1731

getEnrollmentSummary

getEnrollmentSummary(
    receiver: BACNetAddress,
    acknowledgmentFilter: number,
    options?: EnrollmentOptions,
): Promise<EnrollmentSummaryAcknowledge>
Gets enrollment summary from a device.
Parameters
- receiver: BACNetAddress
- acknowledgmentFilter: number
- options: EnrollmentOptions = {}
Returns Promise<EnrollmentSummaryAcknowledge>
- Defined in client.ts:1942

getEventInformation

getEventInformation(
    receiver: BACNetAddress,
    objectId: BACNetObjectID,
    options?: ServiceOptions,
): Promise<BACNetEventInformation[]>
Gets event information from a device.
Parameters
- receiver: BACNetAddress
- objectId: BACNetObjectID
- options: ServiceOptions = {}
Returns Promise<BACNetEventInformation[]>
- Defined in client.ts:1777

getMaxListeners

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

iAmResponse

iAmResponse(
    receiver: BACNetAddress,
    deviceId: number,
    segmentation: number,
    vendorId: number,
): void
The iAmResponse command is sent as a reply to a whoIs request.
Parameters
- receiver: BACNetAddress
- deviceId: number
- segmentation: number
- vendorId: number
Returns void
- Defined in client.ts:2102

iHaveResponse

iHaveResponse(
    receiver: BACNetAddress,
    deviceId: BACNetObjectID,
    objectId: BACNetObjectID,
    objectName: string,
): void
Sends an iHave response.
Parameters
- receiver: BACNetAddress
- deviceId: BACNetObjectID
- objectId: BACNetObjectID
- objectName: string
Returns void
- Defined in client.ts:2128

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: BACNetAddress,
    objectId: BACNetObjectID,
    position: number,
    count: number,
    options?: ServiceOptions,
): Promise<DecodeAtomicReadFileResult>
Reads a file from a remote device.
Parameters
- receiver: BACNetAddress
- objectId: BACNetObjectID
- position: number
- count: number
- options: ServiceOptions = {}
Returns Promise<DecodeAtomicReadFileResult>
- Defined in client.ts:1325

readProperty

readProperty(
    receiver: BACNetAddress,
    objectId: BACNetObjectID,
    propertyId: number,
    options?: ReadPropertyOptions,
): Promise<DecodeAcknowledgeSingleResult>
The readProperty command reads a single property of an object from a device.
Parameters
- receiver: BACNetAddress
- objectId: BACNetObjectID
- propertyId: number
- options: ReadPropertyOptions = {}
Returns Promise<DecodeAcknowledgeSingleResult>
- Defined in client.ts:897

readPropertyMultiple

readPropertyMultiple(
    receiver: BACNetAddress,
    propertiesArray: BACNetReadAccessSpecification[],
    options?: ServiceOptions,
): Promise<DecodeAcknowledgeMultipleResult>
The readPropertyMultiple command reads multiple properties in multiple objects from a device.
Parameters
- receiver: BACNetAddress
- propertiesArray: BACNetReadAccessSpecification[]
- options: ServiceOptions = {}
Returns Promise<DecodeAcknowledgeMultipleResult>
- Defined in client.ts:1034

readPropertyMultipleResponse

readPropertyMultipleResponse(
    receiver: BACNetAddress,
    invokeId: number,
    values: BACNetReadAccess[],
): void
Sends a response with information about multiple properties.
Parameters
- receiver: BACNetAddress
- invokeId: number
- values: BACNetReadAccess[]
Returns void
- Defined in client.ts:2082

readPropertyResponse

readPropertyResponse(
    receiver: BACNetAddress,
    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: BACNetAddress
- invokeId: number
- objectId: BACNetObjectID
- property: BACNetPropertyID
- value: BACNetAppData<ApplicationTag, any> | BACNetAppData<ApplicationTag, any>[]
- options: { forwardedFrom?: string } = {}
Returns void
- Defined in client.ts:2050

readRange

readRange(
    receiver: BACNetAddress,
    objectId: BACNetObjectID,
    idxBegin: number,
    quantity: number,
    options?: ServiceOptions,
): Promise<ReadRangeAcknowledge>
Reads a range of data from a remote device.
Parameters
- receiver: BACNetAddress
- objectId: BACNetObjectID
- idxBegin: number
- quantity: number
- options: ServiceOptions = {}
Returns Promise<ReadRangeAcknowledge>
- Defined in client.ts:1374

reinitializeDevice

reinitializeDevice(
    receiver: BACNetAddress,
    state: number,
    options?: ReinitializeDeviceOptions,
): Promise<void>
The reinitializeDevice command initiates a restart of the target device.
Parameters
- receiver: BACNetAddress
- state: number
- options: ReinitializeDeviceOptions = {}
Returns Promise<void>
- Defined in client.ts:1234

removeAllListeners

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

removeListElement

removeListElement(
    receiver: BACNetAddress,
    objectId: BACNetObjectID,
    reference: { id: number; index: number },
    values: BACNetAppData<ApplicationTag, any>[],
    options?: ServiceOptions,
): Promise<void>
Removes an element from a list property
Parameters
- receiver: BACNetAddress
- objectId: BACNetObjectID
- reference: { id: number; index: number }
- values: BACNetAppData<ApplicationTag, any>[]
- options: ServiceOptions = {}
Returns Promise<void>
- Defined in client.ts:1641

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: BACNetAddress, 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: BACNetAddress
- resultCode: number
Returns void
- Defined in client.ts:2217

sendBvlc

sendBvlc(receiver: BACNetAddress, buffer: EncodeBuffer): void
Sends a BACnet Virtual Link Control message.
Parameters
- receiver: BACNetAddress
- buffer: EncodeBuffer
Returns void
- Defined in client.ts:2185

setMaxListeners

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

simpleAckResponse

simpleAckResponse(
    receiver: BACNetAddress,
    service: number,
    invokeId: number,
): void
Sends a simple acknowledgement response.
Parameters
- receiver: BACNetAddress
- service: number
- invokeId: number
Returns void
- Defined in client.ts:2148

subscribeCov

subscribeCov(
    receiver: BACNetAddress,
    objectId: BACNetObjectID,
    subscribeId: number,
    cancel: boolean,
    issueConfirmedNotifications: boolean,
    lifetime: number,
    options?: ServiceOptions,
): Promise<void>
Subscribes to Change of Value (COV) notifications for an object
Parameters
- receiver: BACNetAddress
- objectId: BACNetObjectID
- subscribeId: number
- cancel: boolean
- issueConfirmedNotifications: boolean
- lifetime: number
- options: ServiceOptions = {}
Returns Promise<void>
- Defined in client.ts:1433

subscribeProperty

subscribeProperty(
    receiver: BACNetAddress,
    objectId: BACNetObjectID,
    monitoredProperty: BACNetPropertyID,
    subscribeId: number,
    cancel: boolean,
    issueConfirmedNotifications: boolean,
    options?: ServiceOptions,
): Promise<void>
Subscribes to Change of Value (COV) notifications for a specific property
Parameters
- receiver: BACNetAddress
- objectId: BACNetObjectID
- monitoredProperty: BACNetPropertyID
- subscribeId: number
- cancel: boolean
- issueConfirmedNotifications: boolean
- options: ServiceOptions = {}
Returns Promise<void>
- Defined in client.ts:1478

timeSync

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

timeSyncUTC

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

unconfirmedCOVNotification

unconfirmedCOVNotification(
    receiver: BACNetAddress,
    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: BACNetAddress
- subscriberProcessId: number
- initiatingDeviceId: number
- monitoredObjectId: BACNetObjectID
- timeRemaining: number
- values: {
  property: { id: number; index?: number };
  value: BACNetAppData<ApplicationTag, any>[];
  }[]
Returns void
- Defined in client.ts:1526

unconfirmedEventNotification

unconfirmedEventNotification(
receiver: BACNetAddress,
eventNotification: EventNotifyDataParams,
): void
Sends an unconfirmed event notification.
Parameters
- receiver: BACNetAddress
- eventNotification: EventNotifyDataParams
Returns void
- Defined in client.ts:1993

unconfirmedPrivateTransfer

unconfirmedPrivateTransfer(
    receiver: BACNetAddress,
    vendorId: number,
    serviceNumber: number,
    data: number[],
): void
Sends an unconfirmed private transfer.
Parameters
- receiver: BACNetAddress
- vendorId: number
- serviceNumber: number
- data: number[]
Returns void
- Defined in client.ts:1922

whoIs

whoIs(
receiverOrOptions?: BACNetAddress | WhoIsOptions,
options?: WhoIsOptions,
): void
The whoIs command discovers all BACNET devices in a network.
Parameters
- OptionalreceiverOrOptions: BACNetAddress | WhoIsOptions
- Optionaloptions: WhoIsOptions
Returns void
Fires
BACnetClient.iAm
- Defined in client.ts:820

writeFile

writeFile(
    receiver: BACNetAddress,
    objectId: BACNetObjectID,
    position: number,
    fileBuffer: number[][],
    options?: ServiceOptions,
): Promise<DecodeAtomicWriteFileResult>
Writes a file to a remote device.
Parameters
- receiver: BACNetAddress
- objectId: BACNetObjectID
- position: number
- fileBuffer: number[][]
- options: ServiceOptions = {}
Returns Promise<DecodeAtomicWriteFileResult>
- Defined in client.ts:1275

writeProperty

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

writePropertyMultiple

writePropertyMultiple(
    receiver: BACNetAddress,
    values: WritePropertyMultipleObject[],
    options?: ServiceOptions,
): Promise<void>
The writePropertyMultiple command writes multiple properties in multiple objects to a device.
Parameters
- receiver: BACNetAddress
- values: WritePropertyMultipleObject[]
- options: ServiceOptions = {}
Returns Promise<void>
- Defined in client.ts:1091

`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:2241

Class default

Example

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns default

Methods

acknowledgeAlarm

Parameters

Returns Promise<void>

addListElement

Parameters

Returns Promise<void>

close

Returns void

confirmedCOVNotification

Parameters

Returns Promise<void>

confirmedEventNotification

Parameters

Returns Promise<void>

confirmedPrivateTransfer

Parameters

Returns Promise<void>

createObject

Parameters

Returns Promise<void>

deleteObject

Parameters

Returns Promise<void>

deviceCommunicationControl

Parameters

Returns Promise<void>

emit

Type Parameters

Parameters

Returns boolean

errorResponse

Parameters

Returns void

eventNames

Returns (keyof BACnetClientEvents)[]

getAlarmSummary

Parameters

Returns Promise<BACNetAlarm[]>

getEnrollmentSummary

Parameters

Returns Promise<EnrollmentSummaryAcknowledge>

getEventInformation

Parameters

Returns Promise<BACNetEventInformation[]>

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