Thread Rating:
  • 0 Vote(s) - 0 Average
  • 1
  • 2
  • 3
  • 4
  • 5
Class: DeviceInfo
#1
General Description

This thread is for discussion of the DEVI device class. The purpose of this device class is to expose information about the device under control in a generic way. Many devices expose information like model name, firmware version, etc..., so for those drivers that choose to expose that information, this device can be used to make a subset of it universally comprehensible.

Fields Provided

[INDENT]Fields of this class will be of this general format:

DEVI#sub_fieldname

where DEVI# indicates it is a device information class field. sub_ is only used if there are multiple sub-devices within the device, see below, and fieldname is the actual specific field name, the possible values of which are enumerated below.
  • Firmware - This is a read-only String field which contains the formatted firmware version info. The content is device specific and no assumptions should be made about it. If this information is not available, it should be empty.
  • Model - This is a read-only String field which contains the model name if available. If not, it should be empty. The content is device specific and no assumptions should be made about it.
[/INDENT]

Multi-Unit Considerations

[INDENT]In the event that the device actually contains multiple sub-devices, each of which exposes this sort of information, then the field names should include a sub-unit indicator. These can be named if appropriate, or numbered if all the sub-units are identical. So, in the case of the firmware version field, there could be multiple versions, such as:

DEVI#Main_Firmware
DEVI#Sec_Firmware

As required. If the units were just multiple, identical units, then the _sub value should be a 1 based, incrementing number.
[/INDENT]

Power Management Issues
[INDENT]The device info class does not require that the driver implement the Power class. However, some devices may not provide that information until they are powered on. If so, the driver MUST set the two fields to the value "[Unknown]", without the quotes of course, upon initialization, so that it clearly indicates that the information is not available. Once the device powers up the driver can then store the real values. If the device inherently knows the model, but must wait for power to get the Firmware info, it MAY set the model upon initialization and only do the delayed setting for the Firmware field.[/INDENT]

Backdoor Commands/Queries

[INDENT]None are required at this time.[/INDENT]
Dean Roddey
Explorans limites defectum
Reply
#2
(reserved for expansion)
Dean Roddey
Explorans limites defectum
Reply
#3
This simple one could be quite useful. Does the above make sense? Anything else that might reasonably added to the field list that would be available in more than a wee percentage of devices?
Dean Roddey
Explorans limites defectum
Reply
#4
Rather than Firmware, why not just Version. Seems a lot less technical and more user friendly...
Wuench
My Home Theater/Automation Website

[THREAD=5957]BlueGlass CQC Config[/THREAD]
[THREAD=10624]Wuench's CQC Drivers[/THREAD]
Reply
#5
Partly because there may be a hardware version as well, and I was considering adding that. So we'd need to keep them separate.
Dean Roddey
Explorans limites defectum
Reply


Possibly Related Threads…
Thread Author Replies Views Last Post
  Class: Security Dean Roddey 34 35,415 01-02-2019, 12:26 PM
Last Post: Dean Roddey
  Class: Weather Dean Roddey 6 6,687 10-11-2018, 11:09 AM
Last Post: Dean Roddey
  Class: Thermostat Dean Roddey 17 26,479 01-29-2016, 10:15 AM
Last Post: Dean Roddey
  Class: SceneCtrl Dean Roddey 20 20,836 03-31-2015, 12:38 PM
Last Post: Dean Roddey
  Class: Irrigation Dean Roddey 8 9,530 01-28-2015, 12:09 PM
Last Post: Dean Roddey
  Class: NowPlaying Dean Roddey 8 9,782 09-23-2014, 02:01 PM
Last Post: Dean Roddey
  Class: Switcher Dean Roddey 9 10,625 08-20-2014, 08:17 AM
Last Post: Dean Roddey
  Class: Projector Dean Roddey 29 27,005 08-11-2014, 08:56 AM
Last Post: Dean Roddey
  Class: Lock Dean Roddey 5 7,189 07-31-2014, 01:24 PM
Last Post: Dean Roddey
  Class: ContactClosure Dean Roddey 7 8,739 07-31-2014, 10:14 AM
Last Post: Dean Roddey

Forum Jump:


Users browsing this thread: 1 Guest(s)