Class default

Index

Constructors

Properties

Methods

_addWebSocketSubscription _alarmDevices _alarms _capabilities _deleteWebSocketSubscription _details _doorbellDetails _doorbells _getWebSocketSubscriptions _houseActivities _houseDetails _houses _houseTemperature _locks _pins _setAlarmState _status _subscribe _user _wakeupDoorbell addSimpleProps addWebSocketSubscription alarmDevices alarms authorize capabilities delete deleteWebSocketSubscription destroy details doorbellDetails doorbells end fetch get getWebSocketSubscriptions houseActivities houseDetails houses houseTemperature lock lockAsync locks onPubNubStatus pins post put setAlarmState status statusAsync subscribe unlatch unlatchAsync unlock unlockAsync user validate wakeupDoorbell addSimpleProps addWebSocketSubscription alarmDevices alarms authorize capabilities deleteWebSocketSubscription details doorbellDetails doorbells getWebSocketSubscriptions houseActivities houseDetails houses houseTemperature lock lockAsync locks pins setAlarmState status statusAsync subscribe unlatch unlatchAsync unlock unlockAsync user validate wakeupDoorbell

Constructors

constructor

new default(config: config): default
Parameters
- config: config
Returns default
- Defined in index.ts:55

Properties

config

config: config

token

token: any

Methods

_addWebSocketSubscription

_addWebSocketSubscription(): Promise<any>
Returns Promise<any>
- Defined in index.ts:287

_alarmDevices

_alarmDevices(alarmId: string): Promise<any>
Parameters
- alarmId: string
Returns Promise<any>
- Defined in index.ts:387

_alarms

_alarms(): Promise<any>
Returns Promise<any>
- Defined in index.ts:379

_capabilities

_capabilities(serialNumber: string): Promise<any>
Parameters
- serialNumber: string
Returns Promise<any>
- Defined in index.ts:412

_deleteWebSocketSubscription

_deleteWebSocketSubscription(subscriberId: string): Promise<any>
Parameters
- subscriberId: string
Returns Promise<any>
- Defined in index.ts:303

_details

_details(lockId: string): Promise<AugustLockDetails[]>
Parameters
- lockId: string
Returns Promise<AugustLockDetails[]>
- Defined in index.ts:238

_doorbellDetails

_doorbellDetails(doorbellId: string): Promise<any>
Parameters
- doorbellId: string
Returns Promise<any>
- Defined in index.ts:362

_doorbells

_doorbells(): Promise<any>
Returns Promise<any>
- Defined in index.ts:354

_getWebSocketSubscriptions

_getWebSocketSubscriptions(subscriberId?: string): Promise<any>
Parameters
- OptionalsubscriberId: string
Returns Promise<any>
- Defined in index.ts:295

_houseActivities

_houseActivities(houseId: string, limit?: number): Promise<any>
Parameters
- houseId: string
- Optionallimit: number
Returns Promise<any>
- Defined in index.ts:328

_houseDetails

_houseDetails(houseId: string): Promise<any>
Parameters
- houseId: string
Returns Promise<any>
- Defined in index.ts:320

_houses

_houses(): Promise<any>
Returns Promise<any>
- Defined in index.ts:312

_houseTemperature

_houseTemperature(houseId: string): Promise<any>
Parameters
- houseId: string
Returns Promise<any>
- Defined in index.ts:336

_locks

_locks(): Promise<any>
Returns Promise<any>
- Defined in index.ts:229

_pins

_pins(lockId: string): Promise<any>
Parameters
- lockId: string
Returns Promise<any>
- Defined in index.ts:404

_setAlarmState

_setAlarmState(
    alarmId: string,
    armState: string,
    areaIds?: string[],
): Promise<any>
Parameters
- alarmId: string
- armState: string
- OptionalareaIds: string[]
Returns Promise<any>
- Defined in index.ts:395

_status

_status(lockId: string): Promise<any>
Parameters
- lockId: string
Returns Promise<any>
- Defined in index.ts:247

_subscribe

_subscribe(lockId: any, callback: any): Promise<() => void>
Parameters
- lockId: any
- callback: any
Returns Promise<() => void>
- Defined in index.ts:421

_user

_user(): Promise<any>
Returns Promise<any>
- Defined in index.ts:345

_wakeupDoorbell

_wakeupDoorbell(doorbellId: string): Promise<any>
Parameters
- doorbellId: string
Returns Promise<any>
- Defined in index.ts:370

addSimpleProps

addSimpleProps(
    obj: {
        doorState?: any;
        info?: any;
        lockID?: any;
        state?: any;
        status?: any;
    },
): void
Parameters
- obj: { doorState?: any; info?: any; lockID?: any; state?: any; status?: any }
Returns void
- Defined in index.ts:443

addWebSocketSubscription

addWebSocketSubscription(): Promise<any>
Returns Promise<any>
- Defined in index.ts:283

alarmDevices

alarmDevices(alarmId: string): Promise<any>
Parameters
- alarmId: string
Returns Promise<any>
- Defined in index.ts:383

alarms

alarms(): Promise<any>
Returns Promise<any>
- Defined in index.ts:375

authorize

authorize(): Promise<boolean>
Returns Promise<boolean>
- Defined in index.ts:216

capabilities

capabilities(serialNumber: string): Promise<any>
Parameters
- serialNumber: string
Returns Promise<any>
- Defined in index.ts:408

delete

delete(endpoint: any): Promise<ApiResponse>
Parameters
- endpoint: any
Returns Promise<ApiResponse>
- Defined in index.ts:189

deleteWebSocketSubscription

deleteWebSocketSubscription(subscriberId: string): Promise<any>
Parameters
- subscriberId: string
Returns Promise<any>
- Defined in index.ts:299

destroy

destroy(): void
Fully tear down this August instance: clears the session token and destroys any PubNub subscription. Call this when you're done with the instance and want to release all resources (WebSocket connection, listeners, timers).

Unlike end(), which is called internally after most API calls and only clears the HTTP auth token, destroy() also tears down the PubNub connection used by subscribe(). After destroy(), any active subscriptions on this instance are stopped.

Returns void
- Defined in index.ts:209

details

details(lockId: string): Promise<AugustLockDetails[]>
Parameters
- lockId: string
Returns Promise<AugustLockDetails[]>
- Defined in index.ts:234

doorbellDetails

doorbellDetails(doorbellId: string): Promise<any>
Parameters
- doorbellId: string
Returns Promise<any>
- Defined in index.ts:358

doorbells

doorbells(): Promise<any>
Returns Promise<any>
- Defined in index.ts:350

end

end(): void
Returns void
- Defined in index.ts:193

fetch

fetch(__namedParameters: FetchOptions): Promise<ApiResponse>
Parameters
- __namedParameters: FetchOptions
Returns Promise<ApiResponse>
- Defined in index.ts:67

get

get(endpoint: any): Promise<ApiResponse>
Parameters
- endpoint: any
Returns Promise<ApiResponse>
- Defined in index.ts:177

getWebSocketSubscriptions

getWebSocketSubscriptions(subscriberId?: string): Promise<any>
Parameters
- OptionalsubscriberId: string
Returns Promise<any>
- Defined in index.ts:291

houseActivities

houseActivities(houseId: string, limit?: number): Promise<any>
Parameters
- houseId: string
- Optionallimit: number
Returns Promise<any>
- Defined in index.ts:324

houseDetails

houseDetails(houseId: string): Promise<any>
Parameters
- houseId: string
Returns Promise<any>
- Defined in index.ts:316

houses

houses(): Promise<any>
Returns Promise<any>
- Defined in index.ts:308

houseTemperature

houseTemperature(houseId: string): Promise<any>
Parameters
- houseId: string
Returns Promise<any>
- Defined in index.ts:332

lock

lock(lockId: string): Promise<AugustLockStatus>
Parameters
- lockId: string
Returns Promise<AugustLockStatus>
- Defined in index.ts:253

lockAsync

lockAsync(lockId: string, hyperBridge?: boolean): Promise<any>
Parameters
- lockId: string
- OptionalhyperBridge: boolean
Returns Promise<any>
- Defined in index.ts:266

locks

locks(): Promise<any>
Returns Promise<any>
- Defined in index.ts:225

onPubNubStatus

onPubNubStatus(callback: (status: any) => void): () => void
Register a callback for PubNub status events. The callback receives the full PubNub status object — branch on status.category (e.g. PNReconnectedCategory, PNNetworkDownCategory).

Returns an unsubscribe function. Safe to call before subscribe() — the listener will be wired to the PubNub instance the first time subscribe() creates it.

Use case: connectivity-recovery detection. PubNub's WebSocket reconnects seconds before HTTP polling would notice that an outage has ended, so this is the fastest signal a homebridge plugin can use to decide it's safe to resume API calls.
Parameters
- callback: (status: any) => void
Returns () => void
- Defined in index.ts:439

pins

pins(lockId: string): Promise<any>
Parameters
- lockId: string
Returns Promise<any>
- Defined in index.ts:400

post

post(endpoint: any, data: any): Promise<ApiResponse>
Parameters
- endpoint: any
- data: any
Returns Promise<ApiResponse>
- Defined in index.ts:181

put

put(endpoint: any, data: any): Promise<ApiResponse>
Parameters
- endpoint: any
- data: any
Returns Promise<ApiResponse>
- Defined in index.ts:185

setAlarmState

setAlarmState(
    alarmId: string,
    armState: string,
    areaIds?: string[],
): Promise<any>
Parameters
- alarmId: string
- armState: string
- OptionalareaIds: string[]
Returns Promise<any>
- Defined in index.ts:391

status

status(lockId: string): Promise<any>
Parameters
- lockId: string
Returns Promise<any>
- Defined in index.ts:243

statusAsync

statusAsync(lockId: string, hyperBridge?: boolean): Promise<any>
Parameters
- lockId: string
- OptionalhyperBridge: boolean
Returns Promise<any>
- Defined in index.ts:278

subscribe(lockId: any, callback: any): Promise<() => void>
Parameters
- lockId: any
- callback: any
Returns Promise<() => void>
- Defined in index.ts:417

unlatch

unlatch(lockId: string): Promise<any>
Parameters
- lockId: string
Returns Promise<any>
- Defined in index.ts:261

unlatchAsync

unlatchAsync(lockId: string, hyperBridge?: boolean): Promise<any>
Parameters
- lockId: string
- OptionalhyperBridge: boolean
Returns Promise<any>
- Defined in index.ts:274

unlock

unlock(lockId: string): Promise<AugustLockStatus>
Parameters
- lockId: string
Returns Promise<AugustLockStatus>
- Defined in index.ts:257

unlockAsync

unlockAsync(lockId: string, hyperBridge?: boolean): Promise<any>
Parameters
- lockId: string
- OptionalhyperBridge: boolean
Returns Promise<any>
- Defined in index.ts:270

user

user(): Promise<any>
Returns Promise<any>
- Defined in index.ts:341

validate

validate(code: string): Promise<boolean>
Parameters
- code: string
Returns Promise<boolean>
- Defined in index.ts:220

wakeupDoorbell

wakeupDoorbell(doorbellId: string): Promise<any>
Parameters
- doorbellId: string
Returns Promise<any>
- Defined in index.ts:366

`Static`addSimpleProps

addSimpleProps(
    config: config,
    obj: {
        doorState?: any;
        info?: any;
        lockID?: any;
        state?: any;
        status?: any;
    },
): void
Parameters
- config: config
- obj: { doorState?: any; info?: any; lockID?: any; state?: any; status?: any }
Returns void
- Defined in index.ts:469

`Static`addWebSocketSubscription

addWebSocketSubscription(config: config): Promise<any>
Parameters
- config: config
Returns Promise<any>
- Defined in index.ts:527

`Static`alarmDevices

alarmDevices(config: config, alarmId: string): Promise<any>
Parameters
- config: config
- alarmId: string
Returns Promise<any>
- Defined in index.ts:579

`Static`alarms

alarms(config: config): Promise<any>
Parameters
- config: config
Returns Promise<any>
- Defined in index.ts:575

`Static`authorize

authorize(config: config): Promise<boolean>
Parameters
- config: config
Returns Promise<boolean>
- Defined in index.ts:473

`Static`capabilities

capabilities(config: config, serialNumber: string): Promise<any>
Parameters
- config: config
- serialNumber: string
Returns Promise<any>
- Defined in index.ts:592

`Static`deleteWebSocketSubscription

deleteWebSocketSubscription(config: config, subscriberId: string): Promise<any>
Parameters
- config: config
- subscriberId: string
Returns Promise<any>
- Defined in index.ts:535

`Static`details

details(config: config, lockId: string): Promise<AugustLockDetails[]>
Parameters
- config: config
- lockId: string
Returns Promise<AugustLockDetails[]>
- Defined in index.ts:485

`Static`doorbellDetails

doorbellDetails(config: config, doorbellId: string): Promise<any>
Parameters
- config: config
- doorbellId: string
Returns Promise<any>
- Defined in index.ts:566

`Static`doorbells

doorbells(config: config): Promise<any>
Parameters
- config: config
Returns Promise<any>
- Defined in index.ts:562

`Static`getWebSocketSubscriptions

getWebSocketSubscriptions(config: config, subscriberId?: string): Promise<any>
Parameters
- config: config
- OptionalsubscriberId: string
Returns Promise<any>
- Defined in index.ts:531

`Static`houseActivities

houseActivities(config: config, houseId: string, limit?: number): Promise<any>
Parameters
- config: config
- houseId: string
- Optionallimit: number
Returns Promise<any>
- Defined in index.ts:548

`Static`houseDetails

houseDetails(config: config, houseId: string): Promise<any>
Parameters
- config: config
- houseId: string
Returns Promise<any>
- Defined in index.ts:544

`Static`houses

houses(config: config): Promise<any>
Parameters
- config: config
Returns Promise<any>
- Defined in index.ts:540

`Static`houseTemperature

houseTemperature(config: config, houseId: string): Promise<any>
Parameters
- config: config
- houseId: string
Returns Promise<any>
- Defined in index.ts:552

`Static`lock

lock(config: config, lockId: string): Promise<AugustLockStatus>
Parameters
- config: config
- lockId: string
Returns Promise<AugustLockStatus>
- Defined in index.ts:493

`Static`lockAsync

lockAsync(config: config, lockId: string, hyperBridge?: boolean): Promise<any>
Parameters
- config: config
- lockId: string
- OptionalhyperBridge: boolean
Returns Promise<any>
- Defined in index.ts:510

`Static`locks

locks(config: config): Promise<any>
Parameters
- config: config
Returns Promise<any>
- Defined in index.ts:481

`Static`pins

pins(config: config, lockId: string): Promise<any>
Parameters
- config: config
- lockId: string
Returns Promise<any>
- Defined in index.ts:588

`Static`setAlarmState

setAlarmState(
    config: config,
    alarmId: string,
    armState: string,
    areaIds?: string[],
): Promise<any>
Parameters
- config: config
- alarmId: string
- armState: string
- OptionalareaIds: string[]
Returns Promise<any>
- Defined in index.ts:583

`Static`status

status(config: config, lockId: string): Promise<any>
Parameters
- config: config
- lockId: string
Returns Promise<any>
- Defined in index.ts:489

`Static`statusAsync

statusAsync(config: config, lockId: string, hyperBridge?: boolean): Promise<any>
Parameters
- config: config
- lockId: string
- OptionalhyperBridge: boolean
Returns Promise<any>
- Defined in index.ts:522

`Static`subscribe

subscribe(config: config, lockId: string, callback?: any): Promise<() => void>
Parameters
- config: config
- lockId: string
- Optionalcallback: any
Returns Promise<() => void>
- Defined in index.ts:505

`Static`unlatch

unlatch(config: config, lockId: string): Promise<any>
Parameters
- config: config
- lockId: string
Returns Promise<any>
- Defined in index.ts:501

`Static`unlatchAsync

unlatchAsync(
    config: config,
    lockId: string,
    hyperBridge?: boolean,
): Promise<any>
Parameters
- config: config
- lockId: string
- OptionalhyperBridge: boolean
Returns Promise<any>
- Defined in index.ts:518

`Static`unlock

unlock(config: config, lockId: string): Promise<AugustLockStatus>
Parameters
- config: config
- lockId: string
Returns Promise<AugustLockStatus>
- Defined in index.ts:497

`Static`unlockAsync

unlockAsync(config: config, lockId: string, hyperBridge?: boolean): Promise<any>
Parameters
- config: config
- lockId: string
- OptionalhyperBridge: boolean
Returns Promise<any>
- Defined in index.ts:514

`Static`user

user(config: config): Promise<any>
Parameters
- config: config
Returns Promise<any>
- Defined in index.ts:557

`Static`validate

validate(config: config, code: string): Promise<boolean>
Parameters
- config: config
- code: string
Returns Promise<boolean>
- Defined in index.ts:477

`Static`wakeupDoorbell

wakeupDoorbell(config: config, doorbellId: string): Promise<any>
Parameters
- config: config
- doorbellId: string
Returns Promise<any>
- Defined in index.ts:570