IPX800 Roll Off Roof ASCOM Driver

ASCOM driver allowing to open a roll off roof with an IPX800 v2, an IPX800 v3 or IPX800 v4.

It allows the opening of any roof whose opening can be triggered by the activation of a relay (e.g. garage door or portal opening system, ...).

Versions 5.x.x

• Microsoft .NET Framework 4.7.2 or above
• Plateform ASCOM 6.2 or above

Versions 4.x.x

• Microsoft .NET Framework 4.5 or above
• Plateform ASCOM 6.2 or above

Older versions

• Microsoft .NET Framework 4 or above
• Plateform ASCOM 6.2 or above

IPX800 settings

IPX800 version

Version of the IPX800: version 2, version 3 or version 4

Protocol

The IPX800 can be controlled using two protocols: M2M (Machine to Machine) or HTTP (equivalent to a control by the web interface).

Note: In case of use of an X880 extension and a firmware version older than v3.05.46 it's recommended to use the HTTP protocol; the extensions do not always react properly to the M2M commands with older version.

IP address and port

IP address and port of the IPX800.

The default port numbers are: 9870 for M2M protocol and 80 for the HTTP protocol.

User and password

The user and password configured to access the web interface of IPX800.

When using the M2M protocol, the password is only required if the firmware version is 5.3.46 or higher.

Relay settings

Relays

These parameters define the behavior of the relay that have to be activated to trigger the opening and closing of the roof.

For each action, "open" and "close", specify the relay number to activate. If configured in pulse mode (from the IPX800 web interface) check the box. If this is not the case it is necessary to indicate the period during which the relay has to be activated.

In the case of an IPX800 v4, it is possible to select a virtual output.

Open/close timeout

If one of the relays is configured in pulse mode, the time required to open / close the roof must be configured. It is recommended to specify a value slightly higher than the actual duration.

Abort mode

The abort mode allows to configure the behavior of the ASCOM Abort Slew functionality. The role of this function is to interrupt the roof slew. Three values are possible:

Not supported: this is the option to select if your system does not allow interruption. The call of ASCOM AbortSlew function will have no effect.

Open relay: Select this option if the interruption of the roof slew can be done by opening the relay.

Close relay: Select this option if the interruption of the roof slew can be done by closing the relay. This is for example the case for some garage door or portal opening system...

Allow opening / closing in case of error

By default, if the status of the driver is on error state, the driver will refuse to execute a closing or opening action.

Enabling this option allows executing the action even if in case of error state.

Sensors settings

Open/close sensor

The driver allows to use sensors (e.g. magnetic sensor) to identify the roof position (open or closed). If you use such detectors, check the boxes and indicate on which entries of IPX800 they are connected.

Security sensor

You can use an entry in the IPX800 as a safety sensor. This can be useful for example to prevent the slew of the roof if the telescope is not at its park position.

Number of attempts

This option is useful on systems where the opening/closing is controlled by a pulse (short closure of the relay, which acts as a switch). If the system does not react to the impulsion, it is possible to repeat the operation. After the time required to open/close the roof, if the detector corresponding to the performed action is not enabled, the driver will try again. And if the sensor is still not active after the maximum number of attempts reached the status change to "error."

Initial state

The initial state allows to specify the roof position at the time of connection. This can be useful if you manually open the roof before connecting to the driver. If a sensor is used, it will always override the state indicated in the configuration.

v5.0.0 (2020-08-20)

• Fixed the input management in the case of the IPX800 v2
• Fixed a bug causing an error when the "Abort" function is called immediately after the execution of the opening / closing with an IPX800 v4 and a relay in impulse mode
• Improvement in handling of actions, open/close sensor detection, ...
• Improvement in error handling
• Improvement in logs handling
• Numerous non visible modifications improving driver operation

v4.1.0 (2019-02-24)

• Added the possibility to open or close the roof even if the status is on error
• Upgrade of the library used to communicate with the IPX800

v4.0.1 (2018-05-11)

• Documentation update

v4.0.0 (2018-05-10)

• Minimum .NET version is now 4.5.0
• Various corrections and optimisations
• Removed Update frequency parameter

v3.2.1 (2017-07-18)

• Correction of an error preventing to write the logs

v3.2.0 (2017-07-08)

• Support of IPX800 v4 virtual outputs

v3.1.1 (2017-02-18)

• Increase the timeout of tooltips in the setup dialog box

v3.1.0 (2016-11-20)

• IPX800 v4 support

v3.0.1 (2016-09-29)

• Improvement of the state handling. In cases where the roof moves at a very low speed, it could happen that the state remains open or closed during the roof slew

v3.0.0 (2016-09-27)

• Ability the use of different relays to open and close the roof
• Ability to use an input of the IPX800 to check if it is safe to close or open the roof
• Various minor improvements
• Code refactoring to allow future drivers development for IPX800 controlled domes

v2.4.3 (2015-11-01)

• Fixed an error that can cause a shutterError status on some configurations if the number of close/open attempts is configured with a value above 1

v2.4.2 (2015-04-06)

• English version. If the operating system is in french, this language will be used, otherwise english will be used

v2.4.1 (2015-03-15)

• Modification in AbortSlew to avoid unwanted behavior if called when not slewing
• Improvement in the initial shutter state setting on connection if the shutter was in an unknown state before the last disconnection
• Compatibility with the firmware 3.05.46 and above of the IPX800 v3 when a password is used

v2.4.0 (2015-03-08)

• Improved error handling
• Implementation of the abort function (AbortSlew) of the ASCOM platform
• Fixed a bug that could potentially cause crashes of the calling software if communication with the IPX800 is not possible (eg network problem)

v2.3.0 (2015-02-28)

• IPX800 v2 compatibility

v2.2.0 (2015-02-12)

• Add the ability to try to open/close several times in case of failure

v2.1.2 (2015-02-09)

• Improvement in some log methods

v2.1.1 (2015-02-07)

• Add log when exception is thrown by open/close dome

v2.1.0 (2015-02-01)

• Add the possibility to use the IPX with HTTP protocol

v2.0.0 (2015-01-05)

• New version developed from scratch

v1.1.0 (2014-08-23)

• Various bugs corrections in communications with the IPX800

v1.0.0 (2013-03-07)

• Initial version, created from ASCOM driver template