1.6 Update - New Notification Types (python-openzwave)

[Fishwaldo]

As Per the OZW 1.6 Release Notes, the Notification class has some new types and a UserAlert type that should be displayed to the user

Need to update to support these.

[kdschlosser]

ok couple of things on this. corrections in the docs and also an enum entry with a typo in the name.

enum OpenZWave::Notification::UserAlertNotification

the enum entry Alert_NodeReloadReqired should be Alert_NodeReloadRequired missing the "u"

This is what is there for the docs.

Alert_None	No Alert Currently Present
Alert_ConfigOutOfDate	One of the Config Files is out of date. Use GetNodeId to determine which node is affected.
Alert_MFSOutOfDate	the manufacturer_specific.xml file is out of date.
Alert_ConfigFileDownloadFailed	A Config File failed to download
Alert_DNSError	A error occurred performing a DNS Lookup
Alert_NodeReloadReqired	A new Config file has been discovered for this node, and its pending a Reload to Take Effect
Alert_UnsupportedController	The Controller is not running a Firmware Library we support
Alert_ApplicationStatus_Retry	Application Status CC returned a Retry Later Message
Alert_ApplicationStatus_Queued	Command Has been Queued for execution later
Alert_ApplicationStatus_Rejected	Command has been rejected

and this is what it should be

Alert_None	No alert currently present.
Alert_ConfigOutOfDate	A config file is out of date, use GetNodeId to determine which node(s) are effected.
Alert_MFSOutOfDate	A manufacturer_specific.xml file is out of date.
Alert_ConfigFileDownloadFailed	A config file failed to download.
Alert_DNSError	An error occurred performing a DNS Lookup.
Alert_NodeReloadRequired	A new config file has been discovered for this node, a node reload is required to have the new configuration take affect.
Alert_UnsupportedController	The controller is not running a firmware library that is supported by OpenZWave.
Alert_ApplicationStatus_Retry	The Application Status Command Class returned the message "Retry Later".
Alert_ApplicationStatus_Queued	The command has been queued for later execution.
Alert_ApplicationStatus_Rejected	The command was rejected.

I am not sure if the enum entry name is going to be some kind of an API breaking thing. I just noticed it when adding the user alerts to python_openzwave. I was doing a copy and paste of the notification descriptions and thought it could use a little rewording and also some fixes.

Let me know if I shouldn't post anything about the documentation.

[kdschlosser]

This is now done.

[Fishwaldo]

Fixed the enum - Its a new notification, so I doubt this will break as people are still adopting.

Regarding the documentation fix - The change around "Node(s)" is incorrect. We can only signal a single node.

For Doco fixes, why don't you just submit a PR direct to the OZW repo?

[kdschlosser]

I am going to need some more information from you then. I am thinking that my interpretation of the description of that enum entry is not correct.

when it states config file. this could be one of 2 files. either the user config file or a manufacturer device config file. But in either case wouldn't more then a single node be effected from the file being out of date. I do not imagine that the manufacturer config files are timestamped and checked, but if it is.. if a user has more then one of the same device then more then a single node would be effected.

and if it is the user config file, if that is out of date then all of the node data contained within it is also out of date. more then a single node.

Or is it a specific entry in the config file that is out of date? if that is the case then I am thinking that the description could use some tweaking.

[Fishwaldo]

It’s the device config files that lives in the config//.xml directories.

Each file has a revision number and OZW checks for later revisions on the OZW site.

If you have a few of the same devices you will get a notification for each device.

[kdschlosser]

I got it now, because a notification is received for each node that is effected the GetNodeID is a method that is attached to the notification it's self. Maybe use this for the description would be better.

A config file is out of date, Use the OpenZWave::Notification.GetNodeId method to obtain the ID of the effected node.

might be a better description. thoughts?