replacePluginPropsOnServer vs dev.replaceOnServer

The difference and overlap of
dev.replacePluginPropsOnServer(props)
vs
dev.replaceOnServer()
is not clear to me

When changing
dev.descripton = "abc"
dev.replaceOnServer()
is required to update

props=dev.pluginProps
props[" xx"] = "abc"
dev.replacePluginPropsOnServer(props)
is required

Question:

1. does dev.replaceOnServer() include dev.replacePluginPropsOnServer(props)
2. are both required when changing both
3. does props ( dev = ... & props=dev.pluginProps) has to be refreshed after a dev.replaceOnServer()

Karl

[matt (support)]

Hi Karl,

1. does dev.replaceOnServer() include dev.replacePluginPropsOnServer(props)

replaceOnServer() replaces the entire device instance, which includes everything except states which are merged back in post-replace by the Indigo Server. However, practically speaking you need to use replacePluginPropsOnServer if you change any of the values inside the properties dict. That is because there is no way to modify the plugin properties on a plugin instance except by using that method. Whenever you use dev.pluginProps you are getting a copy (not a reference) of the pluginProps. So for example dev.pluginProps["foo"] = 123 doesn't do anything.

In summary, use replaceOnServer when you modify an attribute of the device instance (dev.name, dev.description, etc.) and use replacePluginPropsOnServer to update the plugin properties dict.

2. are both required when changing both

See answer to Q1 above.

3. does props ( dev = ... & props=dev.pluginProps) has to be refreshed after a dev.replaceOnServer()

No, I believe everything will still be in-sync immediately after the replaceOnServer() call (until something else modifies a property, state, etc.).

to play this back:

Code: Select all

dev = indigo.devices[123]
props = dev.pluginProps
props["abc"] = "123"
dev.replacePluginPropsOnServer(props)

dev = indigo.devices[123]
dev.description= "xyz"
dev.replaceOnServer()


works fine,
while:

Code: Select all

dev = indigo.devices[123]
props = dev.pluginProps
props["abc"] = "123"
dev.replacePluginPropsOnServer(props)

dev.description= "xyz"
dev.replaceOnServer()


does not?
so when changing dev.description and any other prop I need to get/update dev twice?

Karl

[jay (support)]

Code: Select all

dev = indigo.devices[123]
props = dev.pluginProps
props["abc"] = "123"
dev.replacePluginPropsOnServer(props)

dev.description= "xyz"
dev.replaceOnServer()


does not?

Worked fine for me. Note that if you've got the device edit dialog up, it won't dynamically update the notes field - you have to close the dialog then open it back up.

[MODERATOR NOTE]: moved topic to the correct forum.

Thanks that clarifies it.


Sent from my iPhone using Tapatalk