V10 Changes Discussion #259
Replies: 11 comments 96 replies
-
|
...watch this space... Like always, I bet you've got good ideas and will do it the right way. |
Beta Was this translation helpful? Give feedback.
-
|
I would like to be able to access the cached node status information from within a function node. I want to be able to call a function, pass it some parameters, and have it return with a cached value (i.e., the state of a switch node). Hopefully this makes some sense. As far as I know, to do this today, I would have to send a message to the controller node and wait for a response. |
Beta Was this translation helpful? Give feedback.
-
|
Hi @fabnavigator, This is fully supported already - and returns the cached value. The function is getValue - and returns the value that is currently known (it does not poll the device) The function that does poll the device is pollValue - this one you do have to wait for a response but for getValue it's instant. I'm on a mobile currently, but check the wiki on GitHub for getValue. Link: https://github.com/zwave-js/node-red-contrib-zwave-js/wiki/Value-API#getvalue |
Beta Was this translation helpful? Give feedback.
-
|
Looking good! Does the "esc" key cancel out of the dialogs, or do you have to hit the "X"? Also, the real-time log is cool, but how about it at the node level also? The messages sent/received by the selected node. |
Beta Was this translation helpful? Give feedback.
-
|
The logging is direct from the driver. You can filter the logs, to a specific node using the controller node config values (it's there already) but, it's still managed by the driver and not the module. The modal dialogs, I'm still working on |
Beta Was this translation helpful? Give feedback.
-
|
Is the default for the log to report on all nodes? If so, wouldn't it just be a matter of getting the log information as you are, but only display what pertains to the selectd node? If someone did set the controller to only log for a specific node, and you are on another node, you wouldn't get anything. I'm not sure if it could let you know that was the case. |
Beta Was this translation helpful? Give feedback.
-
|
I'm not "getting" the log info in any packaged way. It's tailing the drivers log file and feeding it to the UI using web sockets. The driver can be be configured to only report on a select number of nodes, what that does I don't actually know (never used it) but it's affect will be sees in the live log view, as it's just tailing whatever log entries are being written. Configuring the log settings, is on the controller node, in the current version. And most of the settings will remain, only the file path can't be customised on the new version currently. If you don't specify any nodes on the log settings example: 7,5,8 - then it won't be filtered. |
Beta Was this translation helpful? Give feedback.
-
|
I think I understand. |
Beta Was this translation helpful? Give feedback.
-
|
What is peoples thought on this? The topic will be used to contain the API and method of that API example : the properties, will no longer be unnamed in an array, and will now be attached to property names. {
topic: 'VALUE_API.setValue',
payload: {
valueId: {},
nodeId: 345,
value: 3,
options:{}
}
}Using the old method, the current way is: {
payload: {
mode: 'ValueAPI'
method: 'setValue',
node: 345,
params: [<ValueID>,3,<Options>]
}
}I believe this makes for a cleaner, more structured understanding. |
Beta Was this translation helpful? Give feedback.
-
|
So what I'm getting, is that the request format isn't a welcomed change? I will therefore look to keep the same format or warn that it should be updated at least. It will (hopefully) just be a drop-in-place and configure thing, this should only apply to your controller and device nodes. I will soon raise a Draft PR for v9.0.0 - just to aid in documenting the changes. This will change overtime as I progress. |
Beta Was this translation helpful? Give feedback.
-
|
These are the proposed changes to the new message format. CCAPI Example {
payload: {
cmd: 'CCAPI.InvokeCCAPI',
nodeId: 345,
commandClass : number | string,
arguments: [0,0,0],
}
}ValueAP Example (Set Value) {
payload: {
cmd: 'ValuAPI.setValue',
nodeId: 345,
valueId: { }.
SetValueOptions: { }, /* Optional */
value: 34535
}
}And for good measure, obtaining the DB {
payload: {
cmd: 'ControllerAPI.getValueDB',
nodes: [6,5,8] /* Optional */
}
} |
Beta Was this translation helpful? Give feedback.
-
|
Thank you. That will work for me. It would be great if the documentation included the old and new formats together, to make it easy for people to update their code. In terms of newer versions of nodes. I just have a single instance of the controller node. What will happen when I upgrade? Will my old controller node just disappear? |
Beta Was this translation helpful? Give feedback.
-
|
There will be a migration document like there was to aid moving to v4 from v3 (below)
The old controller will be marked as missing, and you just replace with the new node. |
Beta Was this translation helpful? Give feedback.
-
|
I just exported and downloaded the json for my controller node. Thanks for the heads-up. |
Beta Was this translation helpful? Give feedback.
-
|
So... A little update on new access points for the Various APIs. all There will be 4 APIs - each serving a specific area with various methods for each Examples /* Ping a node */
{
payload: {
cmd: 'NODE.ping',
nodeId: 34
}
}
/* Set a node name */
{
payload: {
cmd: 'NODE.setNodeName',
nodeId: 34,
value: 'My Node'
}
}
/* Get Value DB for specific nodes */
{
payload: {
cmd: 'CONTROLLER.getValueDB',
nodes: [34,25] /*Optional*/
}
}
/* Update a value (Value API) */
{
payload: {
cmd: 'VALUE.setValue',
nodeId: 52,
valueId :{},
value : 5352,
setValueOptions:{} /*Optional*/
}
}
/* Update a value (CC API) */
{
payload: {
cmd: 'CC.invokeCCAPI',
commandClass: 'Configuration',
method: 'set',
nodeId: 52,
endpoint: 2, /* Optional */
args:[{"parameter": 4, "value": 0 "valueSize": 1}] /* Optional */
}
}Im still chewing around some bits - but you should hopefully get the idea |
Beta Was this translation helpful? Give feedback.
-
|
These are shortcuts to zwave js internals? |
Beta Was this translation helpful? Give feedback.
-
|
Not 'shortcuts' per se - but named accureltey according to the internals of the underlining driver |
Beta Was this translation helpful? Give feedback.
-
|
Another potential. const Message = {
payload: {
cmd: {
api: 'VALUE',
method: 'setValue'
},
cmdProperties: {
nodeId: 34,
valueId:{ },
value: true,
setValueOptions:{ }
}
}
} |
Beta Was this translation helpful? Give feedback.
-
|
I like that better. More jsonly. |
Beta Was this translation helpful? Give feedback.
-
|
Agreed! |
Beta Was this translation helpful? Give feedback.
-
|
Thoughts! @fabnavigator @crxporter /* You will (likely) be notified that the value has been updated on the device - this is hit and miss now, and is currently the norm */
const Message = {
payload: {
cmd: {
api: 'VALUE',
method: 'setValue'
},
cmdProperties: {
nodeId: 34,
valueId:{ },
value: true,
setValueOptions:{ }
}
}
}
/* You will get an output message with your deliveryReceipt, once the value has been committed to the device
think of battery operated devices for example - that wake up every so often
deliveryReceipt - can be any type of value (number ,string, object)
*/
const Message = {
payload: {
cmd: {
api: 'VALUE',
method: 'setValue'
},
cmdProperties: {
nodeId: 34,
valueId:{ },
value: true,
setValueOptions:{ },
deliveryReceipt: 5645465
}
}
} |
Beta Was this translation helpful? Give feedback.
-
|
I'm ok with those names. |
Beta Was this translation helpful? Give feedback.
-
|
Maybe I was a bit thrown off because trackingToken is the only cmd property that is optional, but there is nothing indicating that. |
Beta Was this translation helpful? Give feedback.
-
|
Yup, the payload is now to this format - which I think is pretty tidy const Message = {
payload: {
cmd: {
api: 'Your Preferred API',
method: 'Method on that API you want to call',
trackingToken: any /* Optional*/
},
cmdProperties: {
"Properties":"required for the Method you are calling"
}
}
} |
Beta Was this translation helpful? Give feedback.
-
|
Would you want to indicate in the comment that it triggers the "TRACKING_TOKEN_RETURN" event? |
Beta Was this translation helpful? Give feedback.
-
|
The Wiki material will document that, yeah 👍 |
Beta Was this translation helpful? Give feedback.
-
|
Another question..... If I have a sensor with 2 channels (Lux, Temp)
|
Beta Was this translation helpful? Give feedback.
-
|
Maybe not so much to me. I would prefer source and target to local and remote. And I'm not sure what root device means. |
Beta Was this translation helpful? Give feedback.
-
|
Root Device = Endpoint 0 |
Beta Was this translation helpful? Give feedback.
-
|
Hi @marcus-j-davies, I don't do many associations, but I got a new remote and want to set some up. It sure would be nice if I could associate to a node name instead of just the node number. I realize that I have write down all of the node numbers for the nodes I want to associate, and then go in and do the associations. |
Beta Was this translation helpful? Give feedback.
-
|
I have been preoccupied lately, so not had chance to progress. I can't ask for a name - as that is not what the protocol wants + plus not everyone names their nodes - but I may instead prompt with a list of nodes when adding an association. I cant promise that the names will be listed in the associations UI though. |
Beta Was this translation helpful? Give feedback.
-
|
That's no problem. We all get preoccupied. A list w/o names probably isn;t worth a change, but a list of "node - name" or "node - " would be nice. |
Beta Was this translation helpful? Give feedback.
-
|
It will be a list of Nodes with names (if you have set the name) Once my time frees up - i'll continue with V9 |
Beta Was this translation helpful? Give feedback.
-
|
I cant remember who asked for this. But the genuine timestamp of a value is now available driver side. it might have been @rgerrans who requested it. |
Beta Was this translation helpful? Give feedback.
-
|
Ooh. I like this. More "real" timestamps! |
Beta Was this translation helpful? Give feedback.
-
|
Yep, that was me when I was working on how to do offline checks. I used the LAST_EVENTS_RESULT you setup to do my checks if a battery device is offline Looking forward to the next version!!! |
Beta Was this translation helpful? Give feedback.
-
|
Get Value DB
Get Value
|
Beta Was this translation helpful? Give feedback.
-
|
Hey everyone, Just a quick update on V9 progress: it's still in my FOV, and I haven't forgotten about it. Apologies for the delay – But 2023 has been unexpectedly busy in both my professional and private life. Despite the hectic schedule, I've been keeping V8 maintained, and V9 will soon be getting the attention it deserves. The upcoming release promises to be groundbreaking, thanks to the enhancements from the Z-Wave JS Driver, which I'm eager to include. Thank you all for your patience and support! |
Beta Was this translation helpful? Give feedback.
-
@crxporter I'm dragging you down with me 😄
but anyone is welcome
Initial Goals
Transition to typescript
Migrate to config nodes
Assumed Barriers
This is no walk in the park, and will take a considerable amount of time.
Beta Was this translation helpful? Give feedback.
All reactions