New driver indi_ocs (#907)

* Initial check in of indi-ocs

* Documentation updates

* Updating to v2.0.3

* Fixed ocs project setup

* Fixed weather interface.

* Fixed button status indication

* Corrected parameter names WI_ -> WEATHER_

* Upped driver version number to 0.3

* Removed repeated error messages.

* Bumped version number and fixed xml.

* Added OCS safety status for info only.

* Removed deprecated WI:: pointer calls

* Bumped version, removed some unused #includes

* Bumped to version 1.0

CMakeLists.txt

@@ -203,6 +203,7 @@ option(WITH_PLAYERONE "Install Player One Astronomy's Camera Driver" On)
 option(WITH_WEEWX_JSON "Install Weewx JSON Driver" On)
 option(WITH_ROLLOFFINO "Install RollOff ino Dome Driver" On)
 option(WITH_ASTROASIS "Install Astroasis Driver" On)
+option(WITH_OCS "Install OCS Driver" On)
 
 # FFMPEG required for INDI Webcam driver
 find_package(FFmpeg)
@@ -769,6 +770,11 @@ SET(LIBRARIES_FOUND FALSE)
 endif(ASTROASIS_FOUND)
 endif(WITH_ASTROASIS)
 
+# OCS
+if (WITH_OCS)
+add_subdirectory(indi-ocs)
+endif()
+
 # Check if libraries are found. If not, we must build them, install them, THEN run CMake again to build and instal the drivers. If all the libraraies are installed, then we build and install the drivers only now.
 if (LIBRARIES_FOUND)
 message(STATUS "############################################################################")

indi-ocs/CMakeLists.txt

@@ -0,0 +1,34 @@
+cmake_minimum_required(VERSION 3.13)
+PROJECT(indi_ocs C CXX)
+
+LIST(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake_modules/")
+LIST(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../cmake_modules/")
+include(GNUInstallDirs)
+
+set(INDI_OCS_VERSION_MAJOR 0)
+set(INDI_OCS_VERSION_MINOR 1)
+
+find_package(INDI REQUIRED)
+find_package(Nova REQUIRED)
+
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/config.h.cmake ${CMAKE_CURRENT_BINARY_DIR}/config.h )
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/indi_ocs.xml.cmake ${CMAKE_CURRENT_BINARY_DIR}/indi_ocs.xml )
+
+include_directories( ${CMAKE_CURRENT_BINARY_DIR})
+include_directories( ${CMAKE_CURRENT_SOURCE_DIR})
+include_directories( ${INDI_INCLUDE_DIR})
+
+include(CMakeCommon)
+
+########### OCS  ###########
+set(indi_ocs_srcs
+   ${CMAKE_CURRENT_SOURCE_DIR}/ocs.cpp
+   )
+
+add_executable(indi_ocs ${indi_ocs_srcs})
+
+target_link_libraries(indi_ocs ${INDI_LIBRARIES} ${NOVA_LIBRARIES})
+
+install(TARGETS indi_ocs RUNTIME DESTINATION bin )
+
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/indi_ocs.xml DESTINATION ${INDI_DATA_DIR})

indi-ocs/Documentation/Indi-ocs.md

@@ -0,0 +1,148 @@
+# Observatory Control System (OCS)
+
+The OCS is an open source (hardware and software) Observatory control that is very flexible and customisable.
+See [OCS groups wiki](https://onstep.groups.io/g/onstep-ocs/wiki) for full info.
+
+## Installation
+
+indi_ocs is released as a 3rd party driver in source and binary packages. It is compatible with libindi >= v2.0.1
+
+## Features
+
+The following features of OCS are supported by this driver:
+
+ - Roll Off Roof / Dome Shutter control
+ - Dome control and mount slaving
+ - Power device control
+ - Lighting control
+ - Observatory thermostat control
+ - Weather monitoring
+
+## Configuration
+Connection via USB and Ethernet are supported.
+If using Ethernet connectivity a persistent port on the OCS is recommended (eg. 9998).
+
+Similar to the modular functionality of the in-build OCS website, options that are not enabled in the OCS config.h are not displayed.
+
+Functional options configured in the OCS software are detected upon connection and applied in the driver. For example, if you have configured a Power Device 1 with a name of "Flats Panel" this name will be used for the control in the driver. Similarly if you have defined a weather device safety limit in the OCS configuration this limit will initially be used in the driver.
+
+The standard INDI Dome parameters configuration is required for Dome slaving.
+
+## Driver Tab walkthrough
+### Main Control
+<img src="Main_Control_Tab.png" alt="Main Control Tab" width="422" height="359" title="Main Control Tab">
+
+- Connection - Connect(ed)/Disconnect(ed) control/indication
+- Shutter - Open(ed)/Close(d) control/indication. For OCS ROR configurations this control is for the **roof**. Unfortunately there is no way to rename this standard control
+- Status > Roof/Shutter - The current status of the roof/shutter system is displayed eg. Open, Closing: Travel 36%, Error code, etc.
+- Absolute Position > Degrees - Setting an Azimuth position instructs the dome to move to it.
+- Abort Motion - Immediately requests a halt of both dome and roof/shutter movement.
+- Sync > Az - Setting an Azimuth position performs a sync on the dome ie. tells it "you are here".
+- Parking - Park(ed)/UnPark(ed) control/indication. Sends the dome to the defined park position/removed the dome from parked status.
+- Additional Controls
+	+ Set Park - Sets the current Azimuth position as the dome park position.
+	+ Return Home - Sends the dome to the defined home position.
+	+ At Home (Reset) - Tells the dome it is at the defined home position.
+- Status > Dome - The current status of the dome eg. Home, Parked, Idle, Slewing, Error code, etc.
+
+### Connection
+<img src="Connection_Tab.png" alt="Connection Tab" width="422" height="359" title="Connection Tab">
+
+Standard INDI Connection tab controls.
+Use either Serial (USB) connection (which in testing of OCS4 hardware showed up as /dev/ttyACM0 or auto mapped /dev/serial/by-id/usb-Teensyduino\_USB\_Serial_12345678-if00) or Network using the OCS address and port 9998.
+
+### Options
+<img src="Options_Tab.png" alt="Options Tab" width="422" height="359" title="Options Tab">
+
+Standard INDI Dome Option tab controls.
+
+- Polling - Sets the refresh period (in ms) of the roof/shutter and dome status.
+- Mount Policy - If set to: Mount locks the the **dome** is prevented from parking when mount is unparked. 
+- Shutter > Close on Park, Open on UnPark. 
+
+**Note that this option is independent of the OCS option ROOF\_CLOSE\_PARKS\_MOUNT. If that option is set in the OCS configuration it is always active. These controls act in addition to that option and are not aware of it.**
+
+### Presets
+<img src="Presets_Tab.png" alt="Presets Tab" width="422" height="359" title="Presets Tab">
+
+Allows creation and GoTo of up to three stored locations of dome Azimuth.
+
+### Slaving
+<img src="Slaving_Tab.png" alt="Slaving Tab" width="422" height="359" title="Slaving Tab">
+
+Controls for configuring the dome > mount slaving functionality. Refer to [INDI Dome Devices](https://www.indilib.org/devices/domes.html) for details.
+
+### Status
+<img src="Status_Tab.png" alt="Status Tab" width="422" height="359" title="Status Tab">
+
+Shows miscellaneous details about the OCS.
+
+- Firmware version - As reported by OCS. The driver expects a minimum version and will report if the connected OCS software is below this.
+- Roof last error - This message is persistent until a roof/shutter movement clears the status.
+- Mains status - This is dependent on OCS configuration and does not contribute toward the Safe status of the observatory within the driver, which is independent of the safe status within OCS.
+- MCU temperature ℃ - the internal temperature of the OCS microcontroller, if supported by the OCS hardware used.
+
+### Weather
+<img src="Weather_Tab.png" alt="Weather Tab" width="442" height="605" title="Weather Tab">
+
+**Note: this tab is only displayed if the Weather function is configured within the OCS software.**
+
+These controls define the minimum and maximum limits outside of which the measurement is considered unsafe to the observatory operation.
+
+- Update > Period (s) - This sets the refresh period for weather measurements. Don't bother going lower than the default 60 seconds as the OCS software internally polls once per minute so a faster refresh will just retrieve stale data.
+- Weather > Refresh - Forces an immediate poll of weather measurements - see note above.
+- Safety > Override Status - Ignore unsafe weather conditions.
+- Status - The safe/unsafe status of the OCS configured measurements.
+- Parameters - The readings returned of the OCS configured measurements.
+- Limits - Each OCS configured weather measurement has three controls, a maximum level above which it's status is considered unsafe, a minimum level below which it's status is considered unsafe, and a percentage towards the limit that is considered to be a warning status
+
+**Note that the OCS internal safety status is independent of these driver settings. OCS considers Rain, Cloud cover, Wind speed & Mains power present towards it's safety status (if they are configured) and will operate independent of these settings and driver connection.**
+
+**Safe limits defined in the OCS software for Wind speed and Cloud cover are copied into the driver as initial limits upon connection. They may be over-ridden here but are not applied back to the OCS software. In addition, temperature, pressure & humidity are considered towards the INDI safety status. If not required for this purpose but only to be monitored, just set the min/max limits very wide so that they are always considered to be safe**.
+
+There are some weather measurements supported by the OCS that can not be used as contributors towards the safety status. If configured in the OCS software these will appear at the bottom of the tab.
+
+- Cloud > description - A text string describing the amount of cloud cover, from "Clear" to "Very-Cldy".
+- Sky Quality> mag/arc-sec² - A measurement of the sky darkness.
+- Sky temp > ℃ - The sky temperature taken from an IR sensor.
+
+### Thermostat
+<img src="Thermostat_Tab.png" alt="Thermostat Tab" width="422" height="359" title="Thermostat Tab">
+
+**Note: this tab is only displayed if the Thermostat function is configured within the OCS software.**
+
+These controls display the status of and control the setpoints of any configured observatory thermostat devices. Readings are update once per minute regardless of the Options > Polling period setting.
+
+- Obsy Status > Temperature ℃ - Internal observatory temperature
+- Obsy Status > Humidity % - Internal observatory humidity
+- Setpoint > Heat ℃ (0=OFF) - If the internal observatory temperature falls below this setpoint the defined Heat Relay is activated, for example to turn on a heater.
+- Setpoint > Cool ℃ (0=OFF) - If the internal observatory temperature rises above this setpoint the defined Cool Relay is activated, for example to turn on a ventilation fan.
+- Setpoint > Dehumidify % (0=OFF) - If the internal observatory humidity rises above this setpoint the defined Humidity Relay is activated, for example to turn on a dehumidifer.
+- Heat Relay/Cool Relay/Rh Relay - These are indication of status only.
+
+**Note that the setpoints are saved in the OCS non-volatile storage and therefore are active until overwritten or disabled regardless of driver connection.**
+
+**Note that there is an OCS option CONTROL\_WITH\_ROOF\_OPEN. If this is set to OFF (the default) then the thermostat setpoint controls are ignored when the roof/shutter is opened. This is independent of this driver.**
+
+### Power
+<img src="Power_Tab.png" alt="Power Tab" width="418" height="330" title="Power Tab">
+
+Any OCS configured power device is shown with the defined name, and ON/OFF controls/status indication that activate the defined relay.
+
+### Lights
+<img src="Lights_Tab.png" alt="Lights Tab" width="418" height="330" title="Lights Tab">
+
+Any OCS configured lighting device is shown with ON/OFF controls/status indication that activate the defined relay.
+
+### Manual
+<img src="Manual_Tab.png" alt="Manual Tab" width="422" height="359" title="Manual Tab">
+
+-
+
+**Note the warning at the top of this tab - these are controls that directly address the hardware in ways that could result in lost data, damage to equipment, or in the worst case sudden movement of equipment that has the potential for injury.**
+
+-
+
+- Interlocks > OVERRIDE. This control causes the roof/shutter interlock signals to be ignored for one movement command. Only intended for testing and/or temporary interlock failure overrides.
+- Roof Power > MAX. This control overrides any configured roof/shutter power level and just enables the motor at 100% power. Only intended for forcing the roof/shutter to close under failure conditions.
+- Watchdog > REBOOT. **If the OCS Watchdog function is configured ON**, and neither the roof/shutter nor the dome are in motion, this control will cause the OCS controller to enter a deadlock forcing the watchdog to reboot the controller.

indi-ocs/INSTALL.txt

@@ -0,0 +1,12 @@
+COMPILE INSTRUCTIONS:
+
+> cmake .
+> make
+> sudo make install
+
+
+TEST INSTRUCTIONS:
+(Tested with Indi 2.0.1)
+
+indiserver ./indi_ocs
+