CalibratorStatus not ASCOM-Compliant

[MiningPickaxe]

ASCOM requires the CalibratorStatus to have one of 6 states: https://ascom-standards.org/Help/Developer/html/T_ASCOM_DeviceInterface_CalibratorStatus.htm

You set it to ready all the time, even if it is off. This should at least change between 1 and 3.

I'll try to implement a fix and open a PR tomorrow, should be relatively easy.

[jlecomte]

Hi! Yes, I remember stumbling upon that while writing the driver. However, considering how the firmware is implemented, I could not see a reason why I would need to use the other states. You say it is not compliant. Is this not working for you when using some ASCOM client application? I have tried it with NINA, and it works fine. That being said, if you open a PR, I will review it. Thank you for the help!

[jlecomte]

I reviewed the ASCOM page you linked to, and I think that what I do is actually correct. The Ready state can be used even when the panel is turned off as long as it is ready to accept commands and is in the expected state. Therefore, I don’t think that this is an issue, and it also does not make the driver non compliant. This is especially true since the driver and firmware are synchronous, and state changes are instantaneous. When the panel is turned off, the Brightness property should be at 0 per https://ascom-standards.org/Help/Developer/html/P_ASCOM_DeviceInterface_ICoverCalibratorV1_Brightness.htm. Feel free to reopen the issue if you think my understanding of the ASCOM API is incorrect. Thank you for the input!

[MiningPickaxe]

I used ASCOM Conform https://ascom-standards.org/COMDeveloper/Conformance.htm to check the driver, I get this report for the implemented methods:

Methods 
14:32:38.127 OpenCover                         OK       CoverStatus is 'NotPresent' and a MethodNotImplementedException exception was generated as expected
14:32:38.174 CloseCover                        OK       CoverStatus is 'NotPresent' and a MethodNotImplementedException exception was generated as expected
14:32:38.221 HaltCover                         OK       CoverStatus is 'NotPresent' and a MethodNotImplementedException exception was generated as expected
14:32:38.273 CalibratorOn                      OK       CalibratorOn with brightness -1 threw an InvalidValueException as expected
14:32:38.314 CalibratorOn                      OK       CalibratorOn with brightness 0 was successful. The synchronous operation took 0,0 seconds
14:32:38.322 CalibratorOn                      OK       The Brightness property does return the value that was set
14:32:38.362 CalibratorOn                      OK       CalibratorOn with brightness 1 was successful. The synchronous operation took 0,0 seconds
14:32:38.368 CalibratorOn                      OK       The Brightness property does return the value that was set
14:32:38.408 CalibratorOn                      OK       CalibratorOn with brightness 2 threw an InvalidValueException as expected
14:32:38.454 CalibratorOff                     ERROR    CalibratorOff was unsuccessful - the returned CalibratorState was 'Ready' instead of 'Off'. The synchronous action took 0,0 seconds

N.I.N.A. does indeed not care about this and works just fine.

If you turn off the calibrator the brightness should indeed be 0, but how I understand the Conform output and documentation about the CalibratorStatus, a call to CalibratorOff() should set the CalibratorStatus to 1.

The Calibrator is "Ready" when the light is on and brightess > 0 and it is "Ready" to be used and it is "Off" if the light is off and the brightness == 0.

With my fix applied the output looks like this:

Methods 
14:39:02.618 OpenCover                         OK       CoverStatus is 'NotPresent' and a MethodNotImplementedException exception was generated as expected
14:39:02.669 CloseCover                        OK       CoverStatus is 'NotPresent' and a MethodNotImplementedException exception was generated as expected
14:39:02.716 HaltCover                         OK       CoverStatus is 'NotPresent' and a MethodNotImplementedException exception was generated as expected
14:39:02.766 CalibratorOn                      OK       CalibratorOn with brightness -1 threw an InvalidValueException as expected
14:39:02.810 CalibratorOn                      OK       CalibratorOn with brightness 0 was successful. The synchronous operation took 0,0 seconds
14:39:02.817 CalibratorOn                      OK       The Brightness property does return the value that was set
14:39:02.858 CalibratorOn                      OK       CalibratorOn with brightness 1 was successful. The synchronous operation took 0,0 seconds
14:39:02.864 CalibratorOn                      OK       The Brightness property does return the value that was set
14:39:02.901 CalibratorOn                      OK       CalibratorOn with brightness 2 threw an InvalidValueException as expected
14:39:02.950 CalibratorOff                     OK       CalibratorOff was successful. The synchronous action took 0,0 seconds
14:39:02.957 CalibratorOff                     OK       Brightness is set to zero when the calibrator is turned off

[jlecomte]

OK, interesting. Maybe the ASCOM API docs should be updated? Thank you for opening a PR, I will review it in a couple of weeks, as soon as I’m back from my vacation :)

[MiningPickaxe]

Sure, enjoy your vaca!