diff --git a/common/source/docs/common-master-features.rst b/common/source/docs/common-master-features.rst index 06a2b2e123..68e558d6d0 100644 --- a/common/source/docs/common-master-features.rst +++ b/common/source/docs/common-master-features.rst @@ -8,12 +8,15 @@ This lists features or changes merged in master and build in the "latest" firmwa .. note:: Currently firmware is in the 4.3 stable stage. Items listed are in "latest" but not 4.3 beta and stable releases. -[site wiki="plane,copter,blimp"] +[site wiki="plane,copter"] .. toctree:: :maxdepth: 1 Xacti Camera Gimbals + Nooploop TOF-Sense P + Nooploop TOF-Sense F + Nanoradar NRA24 Other wiki changes [/site] [site wiki="rover"] @@ -22,9 +25,17 @@ This lists features or changes merged in master and build in the "latest" firmwa :maxdepth: 1 Xacti Camera Gimbals + Nooploop TOF-Sense P + Nooploop TOF-Sense F + Nanoradar NRA24 Other wiki changes New Circle Mode [/site] +[site wiki="blimp"] +.. toctree:: + :maxdepth: 1 + Other wiki changes +[/site] [copywiki destination="plane,copter,rover,blimp"] diff --git a/common/source/docs/common-rangefinder-nooploop-tofsense-f.rst b/common/source/docs/common-rangefinder-nooploop-tofsense-f.rst new file mode 100644 index 0000000000..636c41b0b1 --- /dev/null +++ b/common/source/docs/common-rangefinder-nooploop-tofsense-f.rst @@ -0,0 +1,30 @@ +.. _common-rangefinder-nooploop-tofsense-f.rst: + +=================== +Nooploop TOFSense F +=================== + +.. note:: + Support for this sensor is available in firmware versions 4.5 and later. + +The `TOFSense F/FP `__ is +lightweight rangefinder module that provides fast and accurate distance measurements up to 25 meters (FP variant only). +ArduPilot currently supports this sensor only via UART. I2C support will be added in the future. + + +Connecting via UART to Autopilot +================================ + +The ame steps as the Nooploop TOFSense P (UART) can be followed, as linked :ref:`here `. +:ref:`RNGFND1_MAX_CM ` can be changed as per the sensor specifications (1500 for TOFSense F and 2500 for TOFSense FP) + +Connecting via I2C +================== +future driver addition + + +Testing the sensor +================== + +Distances read by the sensor can be seen in the Mission Planner's Flight +Data screen's Status tab. Look for "rangefinder1". diff --git a/common/source/docs/common-rangefinder-nooploop-tofsense-p.rst b/common/source/docs/common-rangefinder-nooploop-tofsense-p.rst new file mode 100644 index 0000000000..884f69a357 --- /dev/null +++ b/common/source/docs/common-rangefinder-nooploop-tofsense-p.rst @@ -0,0 +1,77 @@ +.. _common-rangefinder-nooploop-tofsense-p: + +=================== +Nooploop TOFSense P +=================== + +.. note:: + Support for this sensor is available in firmware versions 4.5 and later. + +The `TOFSense P/PS `__ is +lightweight rangefinder module that provides fast and accurate distance measurements up to 8 meters. +It also has an adjustable field of view (FOV), ranging from 15 to 27 degrees with a measurement resolution of 1mm. +ArduPilot currently supports this sensor via both UART and CAN. + +Connecting to the Autopilot +=========================== + +This sensor my be connected either via UART or CAN. + +Connecting via UART +=================== + +Setup the sensor through the NAssistant Software provided by the manufacturer. More details can be found `here `__. For UART mode, in the setup screen set "Interface" to UART, correct baudrate and Mode to "active". It is recommended to reduce the baudrate from the default 921600, to a smaller option (For example: 230400) + +.. image:: ../../../images/tofsense_uart_active.png + :target: ../_images/tofsense_uart_active.png + + +You can use any spare autopilot Serial/UART port. The diagram below shows how to connect to SERIAL4 and the example parameters will be shown assuming this Serial port is used. + +.. image:: ../../../images/TOFSense_serial.png + :target: ../_images/TOFSense_serial.png + +Set the following parameters: + +- :ref:`SERIAL4_PROTOCOL` = 9 (Lidar) +- :ref:`SERIAL4_BAUD` = 230400 (Or as set in NAssistant) +- :ref:`RNGFND1_TYPE ` = “37" (Reboot after setting this) +- :ref:`RNGFND1_MAX_CM ` = "800" (i.e. 8m max range) +- :ref:`RNGFND1_MAX_CM ` = "2" + + +Connecting via CAN +================== + +Setup the sensor through the NAssistant Software provided by the manufacturer. More details can be found `here `__. For CAN mode, in the setup screen set "Interface" to CAN, Mode to "active", and bitrate to "1000000". You can also set the "ID" to a unique number if planning to use multiple TOFSenseP on a single CAN bus. Setting ID to 0 will accept all ID's. + +.. image:: ../../../images/tofsense_can_active.png + :target: ../_images/tofsense_can_active.png + +.. note:: + ArduPilot does not currently support multiple instances of these rangefinders connected to different CAN ports. If you would like to use multiple instances of these CAN rangefinders together, connect them to the same bus. + +.. warning:: + The 4 Pin JST-GH connector wiring of the sensor does not match with the CAN wiring of most autopilots. Wiring incorrectly can lead to damaged sensor and/or autopilot. + +For a CAN connection you can use any spare CAN port. Since this is not a DroneCAN based sensor, you will not be able to use the connected port with any other type of sensor. The diagram below shows how to connect to CAN2. + +.. image:: ../../../images/TOFSense_can.png + :target: ../_images/TOFSense_can.png + +Set the following parameters + +- :ref:`CAN_P2_DRIVER ` = 1 (to enable the 1st CAN port) +- :ref:`CAN_P2_BITRATE` = 1000000 (Or as set in NAssistant) +- :ref:`CAN_D2_PROTOCOL` = 13 +- :ref:`RNGFND1_TYPE ` = “38" (Reboot after setting this) +- :ref:`RNGFND1_MAX_CM ` = "8000" (i.e. 8m max range) +- :ref:`RNGFND1_MAX_CM ` = "2" +- :ref:`RNGFND1_RECV_ID ` = ID of the sensor (0 to accept all sensors connected) + + +Testing the sensor +================== + +Distances read by the sensor can be seen in the Mission Planner's Flight +Data screen's Status tab. Look for "rangefinder1". diff --git a/common/source/docs/common-rangefinder-nra24.rst b/common/source/docs/common-rangefinder-nra24.rst new file mode 100644 index 0000000000..80d9852695 --- /dev/null +++ b/common/source/docs/common-rangefinder-nra24.rst @@ -0,0 +1,47 @@ +.. _common-rangefinder-nooploop-nra24.rst: + +================ +Nanoradar NRA 24 +================ + +.. note:: + Support for this sensor is available in firmware versions 4.5 and later. + +The `NRA24 `__ is K-band radar commonly used for detecting height above terrain in all-weather conditions. +Currently only connection via CAN is supported. Serial versions of this Radar isn't officially supported. + + +Connecting via CAN +========================= + +Setup the sensor through the NSM Software. In particular set the "ID" to a unique number if planning to use multiple NRA24 on a single CAN bus. You can also set the bitrate from the software. + +.. note:: + ArduPilot does not currently support same CAN rangefinders connected to different CAN ports. If you would like yo use multiple CAN rangefinders together, connect them to the same bus. + + +Connecting to the Autopilot +============================== +Setup the sensor through the NAssistant Software provided by the manufacturer. More details can be found `here `__. Set the "ID" to a unique number if planning to use multiple NRA24 on a single CAN bus. You can also set the bitrate from the software to match the CAN bus bitrate (500000 is recommended). + +For a serial connection you can use any spare CAN port. Since this is not a DroneCAN based sensor, you will not be able to use the connected port with any other sensor. The diagram below shows how to connect to CAN2. + +.. image:: ../../../images/nra24_connection.png + :target: ../_images/nra24_connection.png + +Set the following parameters + +- :ref:`CAN_P2_DRIVER ` = 1 (to enable the 1st CAN port) +- :ref:`CAN_P2_BITRATE` = 500000 (Or as set in NAssistant) +- :ref:`CAN_D2_PROTOCOL` = 14 +- :ref:`RNGFND1_TYPE ` = “39" (Reboot after setting this) +- :ref:`RNGFND1_MAX_CM ` = "19000" (i.e. 200m max range and 10m buffer) +- :ref:`RNGFND1_MAX_CM ` = "60" +- :ref:`RNGFND1_RECV_ID ` = ID of the sensor (0 to accept all distances) + + +Testing the sensor +================== + +Distances read by the sensor can be seen in the Mission Planner's Flight +Data screen's Status tab. Look closely for "rangefinder1". diff --git a/common/source/docs/common-xacti-gimbal.rst b/common/source/docs/common-xacti-gimbal.rst index 29adf91da7..37d13dce53 100644 --- a/common/source/docs/common-xacti-gimbal.rst +++ b/common/source/docs/common-xacti-gimbal.rst @@ -1,7 +1,5 @@ .. _common-xacti-gimbal: -[copywiki destination="plane,copter,rover,blimp"] - ============= Xacti Gimbals ============= diff --git a/images/TOFSense_can.png b/images/TOFSense_can.png new file mode 100644 index 0000000000..ba9239cce7 Binary files /dev/null and b/images/TOFSense_can.png differ diff --git a/images/TOFSense_serial.png b/images/TOFSense_serial.png new file mode 100644 index 0000000000..bae4cc7338 Binary files /dev/null and b/images/TOFSense_serial.png differ diff --git a/images/nra24_connection.png b/images/nra24_connection.png new file mode 100644 index 0000000000..d0249d708b Binary files /dev/null and b/images/nra24_connection.png differ diff --git a/images/tofsense_can_active.png b/images/tofsense_can_active.png new file mode 100644 index 0000000000..5d13f1c13e Binary files /dev/null and b/images/tofsense_can_active.png differ diff --git a/images/tofsense_uart_active.png b/images/tofsense_uart_active.png new file mode 100644 index 0000000000..941bd25f4f Binary files /dev/null and b/images/tofsense_uart_active.png differ