Set Error State not working

I have the following code in a plugin:

Code: Select all

                            if muted:
                                dev.description = "MUTED"
                                dev.replaceOnServer()
                                dev.setErrorStateOnServer("Error")
                            else:
                                dev.description = ""
                                dev.replaceOnServer()
                                dev.setErrorStateOnServer(None)

When the code runs, if muted is True the Notes field shows the word "MUTED" but the device does not turn red or show the "Error" text.

Any suggestions gratefully received!

[jay (support)]

I'm not seeing that behavior - I wonder if maybe there's a race condition. Try doing the setErrorStateOnServer before doing the replaceOnServer call.

[MODERATOR NOTE]: moved topic to the sdk support forum

Same result Jay.

Shot in the dark -- any chance the device in question is not owned by your plugin?

Definitely mine Dave!

[jay (support)]

Reload the plugin in an interactive shell, get the dev instance, then try to set the error state that way.

OK, this is weird.

I've added code to check the device props immediately before and after setting the error state. Before the set statement it shows "errorState: " and after it shows "errorState: Error" as it should, but next time through the code the 'before' check shows errorState blank again - in other words, the set error is not being remembered. My plugin has no other set error statements (I've commented out the error clearing code).

[jay (support)]

That is very odd. Pretty sure there's something in your plugin that's resetting it. I wonder if that section of code is getting called twice, once with muted True followed by False?

The only setErrorStateOnServer statement is the one that sets it to “Error”. There are no others - I have them commented out. Is there any other call which could reset the error state?

The only setErrorStateOnServer statement is the one that sets it to “Error”. There are no others - I have them commented out. Is there any other call which could reset the error state?

Yes, any subsequent device update will reset the error state.

From the documentation for updateStateOnServer(key='keyName', value='Value', clearErrorState=True):

Use this method to update the value of one of your device's states on the server. The server will propagate the change out to any connected clients and fire any triggers that are defined on that state. Pass “true” (default) or “false” on the clearErrorState parameter (not required) to have the error state of the device (set with setErrorStateOnServer above) cleared.

Thanks Jon, I’d read that, but I don’t include the clearErrorState parameter in my updates. Unless Indigo defaults to clearErrorState = True in the absence of a specific declaration?

Yep. Turns out you have to explicitly include clearErrorState=False in any device updates to avoid resetting the error state.

Yep. Turns out you have to explicitly include clearErrorState=False in any device updates to avoid resetting the error state.

Yes, that's why the docs say ... Pass “true” (default) ... when referring to the clearErrorState parameter.

[jay (support)]

Right. The most common use-case is that some error occurs, so an update to a device won't happen again until the error condition is resolved. Obviously, that's just the common use-case, we added the flag so that you could maintain the error state through device updates if you wanted.