Class ESPCDFNode

Implements

ESPCDFNodeInterface

Indexable

[key: string]: any

Constructors

constructor

new ESPCDFNode(nodeData: ESPCDFNodeInterface): ESPCDFNode
Parameters
- nodeData: ESPCDFNodeInterface
Returns ESPCDFNode
- Defined in src/entities/ESPCDFNode.ts:99

Properties

_raw

_raw: any

`Optional`availableTransports

availableTransports?: Partial<Record<string, ESPCDFTransportConfig>>

Available transports with their configurations

`Optional`connectivityStatus

connectivityStatus?: ESPCDFConnectivityStatusInterface

`Optional`devices

devices?: ESPCDFDevice[]

`Readonly`events

events: ESPCDFOperationEventEmitter<ESPCDFNode, ESPCDFNodeOperationType>

id

id: string

identifier

identifier: string

`Optional`isMatter

isMatter?: boolean

`Optional`isPrimaryUser

isPrimaryUser?: boolean

`Optional`metadata

metadata?: Record<string, any>

`Optional`nodeConfig

nodeConfig?: ESPCDFNodeConfig

`Optional`nodeType

nodeType?: string

operations

operations: ESPCDFNodeOperation

`Optional`role

role?: string

`Optional`services

services?: ESPCDFService[]

`Optional`tags

tags?: string[]

`Optional`transportOrder

transportOrder?: string[]

Transport order - priority queue of transport modes

`Optional`type

type?: string

Methods

`Optional`checkOTAUpdate

checkOTAUpdate?(): Promise<ESPCDFAPIDataResponse<ESPCDFOTAUpdateResponse>>
Returns Promise<ESPCDFAPIDataResponse<ESPCDFOTAUpdateResponse>>
- Defined in src/entities/ESPCDFNode.ts:249

delete

delete(): Promise<ESPCDFAPIResponse<any>>
Returns Promise<ESPCDFAPIResponse<any>>
- Defined in src/entities/ESPCDFNode.ts:230

dispose

dispose(): void
Remove all listeners and clean up

Returns void
- Defined in src/entities/ESPCDFNode.ts:146

emitPropertyChange

emitPropertyChange(event: ESPCDFPropertyChangeEvent): void
Emit a property change event This is called internally when properties are updated Can also be called externally (e.g., from store handlers)
Parameters
- event: ESPCDFPropertyChangeEvent
  The typed property change event
Returns void
- Defined in src/entities/ESPCDFNode.ts:215

getOTAUpdateStatus

getOTAUpdateStatus(otaJobId: string): Promise<any>
Parameters
- otaJobId: string
Returns Promise<any>
- Defined in src/entities/ESPCDFNode.ts:276

offPropertyChange

offPropertyChange(callback: ESPCDFPropertyChangeCallback): void
Unregister a property change callback
Parameters
- callback: ESPCDFPropertyChangeCallback
Returns void
- Defined in src/entities/ESPCDFNode.ts:205

onPropertyChange

onPropertyChange(callback: ESPCDFPropertyChangeCallback): () => void
Register a callback for property change events This allows adaptors to listen to property changes and sync to _raw
Parameters
- callback: ESPCDFPropertyChangeCallback
  The callback function to register
Returns () => void
Unsubscribe function
- Defined in src/entities/ESPCDFNode.ts:198

pushOTAUpdate

pushOTAUpdate(params: any): Promise<any>
Parameters
- params: any
Returns Promise<any>
- Defined in src/entities/ESPCDFNode.ts:263

setMultipleParams

setMultipleParams(params: Record<string, any>): Promise<ESPCDFAPIResponse<any>>
Parameters
- params: Record<string, any>
Returns Promise<ESPCDFAPIResponse<any>>
- Defined in src/entities/ESPCDFNode.ts:220

setTimeZone

setTimeZone(timeZone: string): Promise<ESPCDFAPIResponse<any>>
Parameters
- timeZone: string
Returns Promise<ESPCDFAPIResponse<any>>
- Defined in src/entities/ESPCDFNode.ts:289

subscribe(
listener: ESPCDFOperationListener<ESPCDFNode, ESPCDFNodeOperationType>,
): () => void
Subscribe to all operation events
Parameters
- listener: ESPCDFOperationListener<ESPCDFNode, ESPCDFNodeOperationType>
  The callback function to register
Returns () => void
Unsubscribe function
- Defined in src/entities/ESPCDFNode.ts:137

updateMetadata

updateMetadata(params: any): Promise<any>
Parameters
- params: any
Returns Promise<any>
- Defined in src/entities/ESPCDFNode.ts:235