_src_controller_model_device_.device.md

zigbee-herdsman

Globals / "src/controller/model/device" / Device

Class: Device

Hierarchy

• Entity

  ↳ Device

Index

Accessors

• applicationVersion
• dateCode
• endpoints
• hardwareVersion
• ieeeAddr
• interviewCompleted
• interviewing
• lastSeen
• linkquality
• manufacturerID
• manufacturerName
• modelID
• networkAddress
• powerSource
• softwareBuildID
• stackVersion
• type
• zclVersion

Methods

• createEndpoint
• getEndpoint
• getEndpointByDeviceType
• interview
• lqi
• onZclData
• ping
• removeFromDatabase
• removeFromNetwork
• routingTable
• save
• updateLastSeen
• all
• byIeeeAddr
• byNetworkAddress
• byType
• create
• injectAdapter
• injectDatabase

Object literals

• ReportablePropertiesMapping

Accessors

applicationVersion

• get applicationVersion(): number

Defined in src/controller/model/device.ts:54

Returns: number

• set applicationVersion(applicationVersion: number): void

Defined in src/controller/model/device.ts:55

Parameters:

Name	Type
applicationVersion	number

Returns: void

---

dateCode

• get dateCode(): string

Defined in src/controller/model/device.ts:63

Returns: string

• set dateCode(dateCode: string): void

Defined in src/controller/model/device.ts:64

Parameters:

Name	Type
dateCode	string

Returns: void

---

endpoints

• get endpoints(): Endpoint[]

Defined in src/controller/model/device.ts:56

Returns: Endpoint[]

---

hardwareVersion

• get hardwareVersion(): number

Defined in src/controller/model/device.ts:66

Returns: number

• set hardwareVersion(hardwareVersion: number): void

Defined in src/controller/model/device.ts:65

Parameters:

Name	Type
hardwareVersion	number

Returns: void

---

ieeeAddr

• get ieeeAddr(): string

Defined in src/controller/model/device.ts:52

Returns: string

• set ieeeAddr(ieeeAddr: string): void

Defined in src/controller/model/device.ts:53

Parameters:

Name	Type
ieeeAddr	string

Returns: void

---

interviewCompleted

• get interviewCompleted(): boolean

Defined in src/controller/model/device.ts:57

Returns: boolean

---

interviewing

• get interviewing(): boolean

Defined in src/controller/model/device.ts:58

Returns: boolean

---

lastSeen

• get lastSeen(): number

Defined in src/controller/model/device.ts:59

Returns: number

---

linkquality

• get linkquality(): number

Defined in src/controller/model/device.ts:88

Returns: number

• set linkquality(linkquality: number): void

Defined in src/controller/model/device.ts:89

Parameters:

Name	Type
linkquality	number

Returns: void

---

manufacturerID

• get manufacturerID(): number

Defined in src/controller/model/device.ts:60

Returns: number

---

manufacturerName

• get manufacturerName(): string

Defined in src/controller/model/device.ts:67

Returns: string

• set manufacturerName(manufacturerName: string): void

Defined in src/controller/model/device.ts:68

Parameters:

Name	Type
manufacturerName	string

Returns: void

---

modelID

• get modelID(): string

Defined in src/controller/model/device.ts:70

Returns: string

• set modelID(modelID: string): void

Defined in src/controller/model/device.ts:69

Parameters:

Name	Type
modelID	string

Returns: void

---

networkAddress

• get networkAddress(): number

Defined in src/controller/model/device.ts:71

Returns: number

• set networkAddress(networkAddress: number): void

Defined in src/controller/model/device.ts:72

Parameters:

Name	Type
networkAddress	number

Returns: void

---

powerSource

• get powerSource(): string

Defined in src/controller/model/device.ts:78

Returns: string

• set powerSource(powerSource: string): void

Defined in src/controller/model/device.ts:79

Parameters:

Name	Type
powerSource	string

Returns: void

---

softwareBuildID

• get softwareBuildID(): string

Defined in src/controller/model/device.ts:82

Returns: string

• set softwareBuildID(softwareBuildID: string): void

Defined in src/controller/model/device.ts:83

Parameters:

Name	Type
softwareBuildID	string

Returns: void

---

stackVersion

• get stackVersion(): number

Defined in src/controller/model/device.ts:84

Returns: number

• set stackVersion(stackVersion: number): void

Defined in src/controller/model/device.ts:85

Parameters:

Name	Type
stackVersion	number

Returns: void

---

type

• get type(): DeviceType

Defined in src/controller/model/device.ts:62

Returns: DeviceType

• set type(type: DeviceType): void

Defined in src/controller/model/device.ts:61

Parameters:

Name	Type
type	DeviceType

Returns: void

---

zclVersion

• get zclVersion(): number

Defined in src/controller/model/device.ts:86

Returns: number

• set zclVersion(zclVersion: number): void

Defined in src/controller/model/device.ts:87

Parameters:

Name	Type
zclVersion	number

Returns: void

Methods

createEndpoint

▸ createEndpoint(ID: number): Promise<Endpoint>

Defined in src/controller/model/device.ts:142

Parameters:

Name	Type
ID	number

Returns: Promise<Endpoint>

---

getEndpoint

▸ getEndpoint(ID: number): Endpoint

Defined in src/controller/model/device.ts:153

Parameters:

Name	Type
ID	number

Returns: Endpoint

---

getEndpointByDeviceType

▸ getEndpointByDeviceType(deviceType: string): Endpoint

Defined in src/controller/model/device.ts:158

Parameters:

Name	Type
deviceType	string

Returns: Endpoint

---

interview

▸ interview(): Promise<void>

Defined in src/controller/model/device.ts:331

Returns: Promise<void>

---

lqi

▸ lqi(): Promise<LQI>

Defined in src/controller/model/device.ts:554

Returns: Promise<LQI>

---

onZclData

▸ onZclData(dataPayload: ZclDataPayload, endpoint: Endpoint): Promise<void>

Defined in src/controller/model/device.ts:167

Parameters:

Name	Type
dataPayload	ZclDataPayload
endpoint	Endpoint

Returns: Promise<void>

---

ping

▸ ping(): Promise<void>

Defined in src/controller/model/device.ts:562

Returns: Promise<void>

---

removeFromDatabase

▸ removeFromDatabase(): Promise<void>

Defined in src/controller/model/device.ts:540

Returns: Promise<void>

---

removeFromNetwork

▸ removeFromNetwork(): Promise<void>

Defined in src/controller/model/device.ts:535

Returns: Promise<void>

---

routingTable

▸ routingTable(): Promise<RoutingTable>

Defined in src/controller/model/device.ts:558

Returns: Promise<RoutingTable>

---

save

▸ save(): void

Defined in src/controller/model/device.ts:261

Returns: void

---

updateLastSeen

▸ updateLastSeen(): void

Defined in src/controller/model/device.ts:163

Returns: void

---

all

▸ Staticall(): Device[]

Defined in src/controller/model/device.ts:291

Returns: Device[]

---

byIeeeAddr

▸ StaticbyIeeeAddr(ieeeAddr: string): Device

Defined in src/controller/model/device.ts:276

Parameters:

Name	Type
ieeeAddr	string

Returns: Device

---

byNetworkAddress

▸ StaticbyNetworkAddress(networkAddress: number): Device

Defined in src/controller/model/device.ts:281

Parameters:

Name	Type
networkAddress	number

Returns: Device

---

byType

▸ StaticbyType(type: DeviceType): Device[]

Defined in src/controller/model/device.ts:286

Parameters:

Name	Type
type	DeviceType

Returns: Device[]

---

create

▸ Staticcreate(type: DeviceType, ieeeAddr: string, networkAddress: number, manufacturerID: number, manufacturerName: string, powerSource: string, modelID: string, interviewCompleted: boolean, endpoints: { ID: number ; deviceID: number ; inputClusters: number[] ; outputClusters: number[] ; profileID: number }[]): Device

Defined in src/controller/model/device.ts:296

Parameters:

Name	Type
type	DeviceType
ieeeAddr	string
networkAddress	number
manufacturerID	number
manufacturerName	string
powerSource	string
modelID	string
interviewCompleted	boolean
endpoints	{ ID: number ; deviceID: number ; inputClusters: number[] ; outputClusters: number[] ; profileID: number }[]

Returns: Device

---

injectAdapter

▸ StaticinjectAdapter(adapter: Adapter): void

Inherited from Group.injectAdapter

Defined in src/controller/model/entity.ts:12

Parameters:

Name	Type
adapter	Adapter

Returns: void

---

injectDatabase

▸ StaticinjectDatabase(database: Database): void

Inherited from Group.injectDatabase

Defined in src/controller/model/entity.ts:8

Parameters:

Name	Type
database	Database

Returns: void

Object literals

ReportablePropertiesMapping

▪ Static Readonly ReportablePropertiesMapping: object

Defined in src/controller/model/device.ts:97

Properties:

Name	Type	Value
appVersion	object	{ key: "applicationVersion" = "applicationVersion"; set: (v: number, d: Device) => void }
dateCode	object	{ key: "dateCode" = "dateCode"; set: (v: string, d: Device) => void }
hwVersion	object	{ key: "hardwareVersion" = "hardwareVersion"; set: (v: number, d: Device) => void }
manufacturerName	object	{ key: "manufacturerName" = "manufacturerName"; set: (v: string, d: Device) => void }
modelId	object	{ key: "modelID" = "modelID"; set: (v: string, d: Device) => void }
powerSource	object	{ key: "powerSource" = "powerSource"; set: (v: string, d: Device) => void }
stackVersion	object	{ key: "stackVersion" = "stackVersion"; set: (v: number, d: Device) => void }
swBuildId	object	{ key: "softwareBuildID" = "softwareBuildID"; set: (v: string, d: Device) => void }
zclVersion	object	{ key: "zclVersion" = "zclVersion"; set: (v: number, d: Device) => void }