diff --git a/cmake_modules/UnityBuild.cmake b/cmake_modules/UnityBuild.cmake index 7c133f1257..2a9bbf9452 100644 --- a/cmake_modules/UnityBuild.cmake +++ b/cmake_modules/UnityBuild.cmake @@ -59,7 +59,7 @@ MACRO (ENABLE_UNITY_BUILD TARGET_NAME SOURCE_VARIABLE_NAME UNIT_SIZE EXTENSION) # Limit is zero based conversion of unit_size MATH(EXPR LIMIT ${UNIT_SIZE}-1) SET(FILES ${SOURCE_VARIABLE_NAME}) - # Effectivly ignore the source files from the build, but keep track them for changes. + # Effectively ignore the source files from the build, but keep track them for changes. SET_SOURCE_FILES_PROPERTIES(${${FILES}} PROPERTIES HEADER_FILE_ONLY true) # Counts the number of source files up to the threshold SET(COUNTER ${LIMIT}) diff --git a/drivers/README.md b/drivers/README.md index b931c49f0b..a3818bd38a 100644 --- a/drivers/README.md +++ b/drivers/README.md @@ -8,7 +8,7 @@ All drivers must provide complete and up to date user Documentation. The documen # Documentation Template -Below are some documentation templates that can be used to write new documentation for your driver. Be direct, simple, and make no assumptions on the user knowledge. The documentation should be friendly to new useres with clear instructions accompined with screenshots and visual aids to ensure proper communication. +Below are some documentation templates that can be used to write new documentation for your driver. Be direct, simple, and make no assumptions on the user knowledge. The documentation should be friendly to new useres with clear instructions accompanied with screenshots and visual aids to ensure proper communication. Screenshots for the driver functionalities are required. You can use whatever GUI client of your choice when submitting the screenshots. The format must be JPG and named after the INDI group/tab they belong to (e.g. main_control.jpg, options.jpg..etc). @@ -92,7 +92,7 @@ sudo apt-get update && sudo apt-get install indi-DRIVER_NAME
  • Both: Dome locks & Dome parks policies are applied.

    • Options -
  • Scope Properties: Enter the Primary and Seconday scope information. Up to six different configurations for Primary and Secondary Guider telescopes can be saved separately, each with an optional unique label in Scope Name property.
    • +
  • Scope Properties: Enter the Primary and Secondary scope information. Up to six different configurations for Primary and Secondary Guider telescopes can be saved separately, each with an optional unique label in Scope Name property.
  • Scope Config: Select the active scope configuration.
  • Joystick: Enable or Disable joystick support. An INDI Joystick driver must be running for this function to work. For more details, check the INDI Telescope Joystick tutorial.
    • @@ -103,7 +103,7 @@ sudo apt-get update && sudo apt-get install indi-DRIVER_NAME
  • Motion N/S/W/E: Directional manual motion control. Press the button to start the movement and release the button to stop.
  • Slew Rate: Rate of manual motion control above where 1x equals one sidereal rate.
  • Guide N/S/W/E: Guiding pulses durations in milliseconds. This property is meant for guider application (e.g. PHD2) and not intended to be used directly.
    • -
  • Guiding Rate: Guiding Rate for RA & DE. 0.3 means the mount shall move at 30% of the sidereal rate when the pulse is active. The sideral rate is ~15.04 arcseconds per second. So at 0.3x, the mount shall move 0.3*15.04 = 4.5 arcsecond per second. When receving a pulse for 1000ms, the total theoritical motion 4.5 arcseconds.
    • +
  • Guiding Rate: Guiding Rate for RA & DE. 0.3 means the mount shall move at 30% of the sidereal rate when the pulse is active. The sidereal rate is ~15.04 arcseconds per second. So at 0.3x, the mount shall move 0.3*15.04 = 4.5 arcsecond per second. When receiving a pulse for 1000ms, the total theoretical motion 4.5 arcseconds.
  • Custom Speeds: Customs speeds in RA & DEC axis when performing GOTO.
  • Track Default: Default tracking rate to be used on startup.
  • ST4 N/S/W/E: If the mount is receiving guiding pulses via ST4, apply this rate.
    • @@ -195,7 +195,7 @@ This provides general information about the currently running driver and driver