Skip to content

Latest commit

 

History

History
81 lines (69 loc) · 2.13 KB

com.fastybird.hardware.md

File metadata and controls

81 lines (69 loc) · 2.13 KB

Device hardware description

  • Version: 0.1.0
  • Date: 01/19
  • Author: FastyBird dev

This extension add support for device hardware description


Extension identifier

Reserved ID for this extension is com.fastybird.hardware

Extension datatypes

This extension defines no new datatypes.

Extension attributes

This extension defines nested required attribute:

Topic Direction Description Payload Retained Required
$hw / mac-address Device → Controller Device physical address identifier String Yes Yes
$hw / manufacturer Device → Controller Hardware manufacturer name String Yes Yes
$hw / model Device → Controller Hardware model name String Yes Yes
$hw / version Device → Controller Hardware released version String Yes Yes

Example

/fb/v1/room-smart-switch/$hw/mac-address → "00:0a:95:9d:68:16"
/fb/v1/room-smart-switch/$hw/manufacturer → "Hardware creator"
/fb/v1/room-smart-switch/$hw/model → "awesome light"
/fb/v1/room-smart-switch/$hw/version → "rev.A"