ardupilot/Tools/AP_Periph
Andrew Tridgell 789aab7fee Tools: update periph README.md 2023-09-01 13:04:59 +10:00
..
AP_Periph.cpp AP_Periph: re-structure peripheral code 2023-09-01 13:04:59 +10:00
AP_Periph.h AP_Periph: re-structure peripheral code 2023-09-01 13:04:59 +10:00
GCS_MAVLink.cpp Tools: add and use AP_AHRS_ENABLED 2023-06-21 22:28:48 +10:00
GCS_MAVLink.h AP_Periph: move sysid_my_gcs to be public 2023-06-17 14:49:22 +10:00
Parameters.cpp AP_Periph: re-structure peripheral code 2023-09-01 13:04:59 +10:00
Parameters.h AP_Periph: re-structure peripheral code 2023-09-01 13:04:59 +10:00
README.md Tools: update periph README.md 2023-09-01 13:04:59 +10:00
ReleaseNotes.txt AP_Periph: update release notes for 1.5.1 2023-07-23 09:02:13 +10:00
adsb.cpp AP_Periph: make canard_broadcast non-static 2023-07-05 14:37:51 +10:00
airspeed.cpp AP_Periph: re-structure peripheral code 2023-09-01 13:04:59 +10:00
baro.cpp AP_Periph: re-structure peripheral code 2023-09-01 13:04:59 +10:00
batt_balance.cpp AP_Periph: added battery balance plug node 2023-08-26 21:12:42 +10:00
batt_balance.h AP_Periph: added battery balance plug node 2023-08-26 21:12:42 +10:00
battery.cpp AP_Periph: re-structure peripheral code 2023-09-01 13:04:59 +10:00
buzzer.cpp AP_Periph: re-structure peripheral code 2023-09-01 13:04:59 +10:00
can.cpp AP_Periph: re-structure peripheral code 2023-09-01 13:04:59 +10:00
compass.cpp AP_Periph: re-structure peripheral code 2023-09-01 13:04:59 +10:00
efi.cpp AP_Periph: re-structure peripheral code 2023-09-01 13:04:59 +10:00
esc_apd_telem.cpp AP_Periph: Support APD ESC telemetry 2023-05-25 17:35:27 -07:00
esc_apd_telem.h AP_Periph: Support APD ESC telemetry 2023-05-25 17:35:27 -07:00
gps.cpp AP_Periph: re-structure peripheral code 2023-09-01 13:04:59 +10:00
hardpoint.cpp AP_Periph: re-structure peripheral code 2023-09-01 13:04:59 +10:00
hwing_esc.cpp AP_Periph: re-structure peripheral code 2023-09-01 13:04:59 +10:00
hwing_esc.h AP_Periph: fixed HWESC temperature decoding 2020-04-02 11:43:37 +11:00
i2c.h AP_Periph: added peripheral firmware 2019-08-27 10:29:56 +10:00
msp.cpp AP_Periph: fixed build for include changes 2022-02-22 12:13:19 +11:00
proximity.cpp AP_Periph: re-structure peripheral code 2023-09-01 13:04:59 +10:00
rangefinder.cpp AP_Periph: re-structure peripheral code 2023-09-01 13:04:59 +10:00
rc_in.cpp AP_Periph: fixed handling of first uart for RC input 2023-08-29 08:00:20 +10:00
rc_in.h AP_Periph: move RC IN parameters to sub-object 2023-08-19 20:27:24 +10:00
rc_out.cpp AP_Periph: fixed macos build 2023-08-29 15:09:48 +10:00
serial_tunnel.cpp AP_Periph: re-structure peripheral code 2023-09-01 13:04:59 +10:00
version.cpp AP_Periph: Use new AP_FWVersionDefine header 2020-09-23 20:58:35 +10:00
version.h AP_Periph: prepare for 1.5.0 release 2023-03-27 07:36:19 +11:00
wscript AP_Periph: link more RC output libs 2023-08-24 13:06:40 +10:00

README.md

AP_Periph DroneCAN Peripheral Firmware

This is an ArduPilot based DroneCAN peripheral firmware. This firmware takes advantage of the wide range of sensor drivers in ArduPilot to make building a DroneCAN peripheral firmware easy.

The AP_Periph firmware is based on the same ChibiOS hwdef.dat system that is used to define pinouts for STM32 based flight controllers supported by ArduPilot. That means you can add support for a new DroneCAN peripheral based on the STM32 by just writing a simple hwdef.dat that defines the pinout of your device.

We have over 60 build targets building for AP_Periph firmwares. All ArduPilot supported MCUs can be used, including:

  • STM32F1xx
  • STM32F3xx
  • STM32F4xx
  • STM32F7xx
  • STM32H7xx
  • STM32L4xx
  • STM32G4xx

More can be added using the hwdef.dat system

Features

The AP_Periph firmware can be configured to enable a wide range of DroneCAN sensor types. Support is included for:

  • GPS modules (including RTK GPS)
  • Magnetometers (SPI or I2C)
  • Barometers (SPI or I2C)
  • Airspeed sensors (I2C)
  • Rangefinders (UART or I2C)
  • ADSB (Ping ADSB receiver on UART)
  • Battery Monitor (Analog, I2C/SMBus, UART)
  • LEDs (GPIO, I2C or WS2812 serial)
  • Safety LED and Safety Switch
  • Buzzer (tonealarm or simple GPIO)
  • RC Output (All standard RCOutput protocols)
  • RC input
  • battery balance monitor
  • EFI engines
  • Proximity sensors

An AP_Periph DroneCAN firmware supports these DroneCAN features:

  • dynamic or static CAN node allocation
  • firmware upload
  • automatically generated bootloader
  • parameter storage in flash
  • easy bootloader update
  • high resiliance features using watchdog, CRC and board checks
  • firmware and parameter update via MissionPlanner or DroneCAN GUI tool when attached to an autopilot
  • firmware update via USB if USB port is provided
  • parameter update using SLCAN and DroneCAN GUI on standalone peripheral via USB, if provided

Building

Using f103-GPS as an example, build the main firmware like this:

  • ./waf configure --board f103-GPS
  • ./waf AP_Periph

that will build a file build/f103-GPS/bin/AP_Periph.bin. You can now load that using the CAN bootloader and either dronecan_gui_tool or MissionPlanner DroneCAN support.

Flashing

To load directly with a stlink-v2, do this:

  • st-flash write build/f103-GPS/bin/AP_Periph.bin 0x8006400

for the CUAV_GPS which loads at offset 0x10000 use this:

  • st-flash write build/CUAV_GPS/bin/AP_Periph.bin 0x8010000

Flashing bootloader

To flash the bootloader use this:

  • st-flash write Tools/bootloaders/f103-GPS_bl.bin 0x8000000

Building bootloader

To build the bootloader use this:

  • Tools/scripts/build_bootloaders.py f103-GPS

the resulting bootloader will be in Tools/bootloaders

Firmware Builds

Firmware targets are automatically built and distributed on the ArduPilot firmware server on firmware.ardupilot.org. These firmwares can be loaded using Mission Planner or the DroneCAN GUI Tool. Parameters for peripherals can be changed using the Mission Planner DroneCAN support or using DroneCAN GUI Tools.

User Bootloader Update

The bootloader is automatically stored in ROMFS in the main firmware. End users can update the bootloader by setting the DroneCAN parameter "FLASH_BOOTLOADER" to 1. After setting it to 1 the node will respond with a debug text message which can be seen in the DroneCAN GUI tool to show the result of the flash.

SITL Testing

A wide range of DroneCAN peripherals are supported in the SITL simulation system. The simplest way of starting a DroneCAN enabled simulated vehicle is to use sim_vehicle.py.

For a quadplane use: sim_vehicle.py with the option -f quadplane-can

For a quadcopter use: sim_vehicle.py with the option -f quad-can

Discussion and Feedback

Please join the discussions at these locations: