dcs-deploy packages serves as a tool for flashing Nvidia Jetson family devices supporting airvolute hardware. It is developed for Python 3 only.
! DISLAIMER - INSTALL THOSE INSIDE HOST PC !
! THIS IS BETA VERSION FOR JP 6.2 SOME ADDITIONAL CONSIDERATIONS MAY APPLY PLEASE REVIEW SECTION KNOWN LIMITATIONS BEFORE USING JP 6.2 here!
sudo apt install qemu-user-static sshpass abootimg lbzip2 jq coreutils findutils
pip install wget
-
Put Jetson into force recovery mode
- Short FC pin with ground on DCS boards (See Control section for your specific board. This example is for DCS 2.0 pilot board.)
- You can check if the device is really in force recovery mode with
lsusbcommand. There should be Nvidia entry in the query. - Next, connect the device to the host pc using dev micro usb connector - again example for DCS 2.0 board.
-
cd into dcs-deploy repo
cd /path/to/dcs-deploy -
Run dcs_deploy.py For example: JetPack 5.1.2, ORIN NX, NVME, Airvolute DCS 2.0 board (with default expander), full rootfs from Nvidia:
python3 dcs_deploy.py flash orin_nx 512 2.0 default nvme fullJetPack 6.2, ORIN NX, NVME, Airvolute DCS 2.0 board (with default expander), full rootfs from Nvidia:
python3 dcs_deploy.py flash orin_nx 62 2.0 default nvme fullNote: Please refer to the section Known limitations - JetPack 6.2 - beta here
You can list supported configs with:
python3 dcs_deploy.py list -
After a successful flash, the Jetson will boot and can be logged in using SSH with default credentials:
- login:
dcs_user - password:
dronecore
- login:
If you shut the Jetson down after flash and then boot it again, make sure you remove cable/jumper that enables Force recovery mode.
You can use your own root filesystem (rootfs) by providing path to it using --rootfs flag. The script will use it as is, without any modifications. Using custom rootfs is useful if you want to create backup of your system or you just don't want to install all the software you typically use on the device each time after flashing.
Please run following commands on the Jetson device:
$ mkdir ~/rootfs_merged
$ cd rootfs_merged
$ sudo tar jxpf ../linux-sample-root-filesystem-r3521aarch64tbz2_original
$ cd ~
$ sudo rsync -axHAWX --numeric-ids --info=progress2 --exclude={"/dev/","/proc/","/sys/","/tmp/","/run/","/mnt/","/media/*","/lost+found","/home/dcs_user/rootfs_merged","/home/dcs_user/.ssh"} / rootfs_merged
$ sudo tar -cf rootfs_merged.tar -C rootfs_merged .
$ pbzip2 -k rootfs_merged.tar # output rootfs_merged.tar.bz2
linux-sample-root-filesystem-r3521aarch64tbz2_originalis the root filesystem provided by Nvidia. You can find this on Nvidia website or it is downloaded with dcs-deploy tool. Find it indownloaddir (see Filesystem section). So, you need to download this file and place it in the home directory of the Jetson.rootfs_mergedis the directory, where the root filesystem will be merged.pbzip2is the compression tool, which is used to compress the tarball. You might need to install it using:
sudo apt install pbzip2
Then you can copy rootfs_merged.tar.bz2 to your host pc and use point to it with --rootfs flag.
- Warning - we advise using
--app_sizeparameter when using custom rootfs. If you do not set it adequately,APPpartition may be too small for your custom rootfs.app_sizeshould be bigger than your custom rootfs.
Massflash package is a flash enviroment that can be used to flash multiple devices connected concurrently to one host pc. The package contains all the necessary files to flash the devices without need of downloading or extracting anything again. This is useful for production environments, where multiple devices need to be flashed.
--massflash_devices is a parameter that can be used to generate massflash package. The parameter takes an integer value, which is the max number of devices that will be able to flash concurrently. If the parameter is not provided, the massflash package is not generated and the script will flash only one device at a time.
Example usage:
python3 dcs_deploy.py flash orin_nx 512 2.0 default nvme full --massflash_devices 21
After sucesfull run, the massflash package will be located in ~/.dcs_deploy/flash/<config_name>/Linux_for_Tegra/mfi_<device_name>.tar.gz directory.
To use this package you can move it to desired location and extract it using sudo tar xpfv mfi_<device_name>.tar.gz.
Then you can flash the device from the folder using sudo ./tools/kernel_flash/l4t_initrd_flash.sh --flash-only --massflash 21 --network usb0 --showlogs command.
When using the massflash it is recommended to prepare the host pc accordingly:
- Run
l4t_flash_prerequisites.shscript fromLinux_for_Tegrafolder. Located at~/.dcs_deploy/flash/<config_name>/Linux_for_Tegra/tools. - Disable USB autosuspend on the host pc. See Flashing issues section for more information.
Note: We imposed a limit of max 50 devices to be flashed concurrently. It is an arbitrary limit, that can be changed in the future if needed.
Use parameter --ext_num_sectors to specify the number of sectors for the external memory. This is useful when you want to flash a specific size of the external memory. The parameter takes an integer value, which is the number of sectors. If the parameter is not provided, the script will use the default size of the external memory.
Note: It is particularly useful when trying to flash lower size NVME drives, which are not supported by default.
If you want to use multiple nvme drives, this is not an issue. Just make sure you plug out secondary NVME during flashing process. After the flashing is successful, you can plug in the secondary NVME. The device will then always boot from the primary NVME (the one that was plugged in during the flashing process).
Keep in mind, that we tried to make this tool as much effective as possible. So, following rules apply:
- When flashing process is ran with the same parameters, the script will not re-generate the images and will not extract downloaded resources again. This is generally ok, but keep in mind that if you alter any files in flash config folder, these changes won't transfer into the next flashing process. If you want to alter anything in the rootfs, you need to alter these files in the rootfs archive and then save it under different name in your PC.
- When any of the steps fail, the script exits and saves the progress. On next run, the script tries to re-run the failed step and continue the whole process from there.
- When you use different rootfs paths each time, the whole flash config folder is re-initialized. That means extracting downloaded resources and generating flash images from scratch. This adds up some time to the process, but it does not break anything.
If you accidentally (or intentionally) left public keys in the rootfs, those are automatically purged. Otherwise each device you flash would be accessible from your host PC which we find harmful. If you feel you want to do this, please find it inside dcs_deploy.py file and comment it out.
There were some issues specific to our platform and to the Jetsons in general, so we decided to fix them after the flashing or to be more specific - after the first boot. The resources/dcs_first_boot.service file is a service that is run at only at the first boot. It runs never again. The service runs resources/dcs_first_boot.sh script on the Jetson device and does following:
- Regenerates SSH keys.
- Sets up fan speed to maximum at all times.
- Sets up basic permissions and UDEV rules so it is in line with Linux standards.
- Sets up USB hubs.
The dcs_deploy.py script can be used instead of Nvidia SDK manager regarding Airvolute hardware. The main advantages are that this package is lightweight and can be used across different Linux distros or Ubuntu versions (SDK manager is strictly tied between Ubuntu and JetPack version). The script does 3 steps in general:
- Download Nvidia and custom Airvolute files.
- Prepare filesystem, which is ready for flashing.
- Flash the device supporting Airvolute boards.
dcs-deploypackage leverages many of Nvidia provided scripts.
Preparing the filesystem is crucial for successful device flashing, despite the carrier board manufacturer. The script prepares/extracts:
Linux For Tegrafolder provided by Nvidia.Airvolute overlay, which satisfies carrier board support (HW) for Jetson devices, that are supported at the moment.Airvolute root filesystem, which is in fact used as a subfolder insideLinux For Tegrafolder. At this time, this is just a barebones minimal clean filesystem generated by Nvidia tools. We expect to populate this filesystem with custom Airvolute software in the near future.
As a root of this filesystem, .dcs_deploy folder is created inside host pc HOME directory. The structure of the folder:
.dcs_deploy/
├─ download/
│ ├─ <source webpage hostname>/<path to resource without "download/downloads">
│ ├─ .../
├─ flash/
│ ├─ config_1/
│ ├─ config_2/
│ ├─ .../
├─ downloaded_versions.json
configis the name of the downloaded/extracted configuration consisting of device type, flashing memory type, airvolute carrier board version and jetpack version. Examplexavier_nx_emmc_1.2_51.downloaded_versions.jsonconsists of configs, that are already downloaded, so if the script is re-ran, those file are not downloaded again and again.downloadcontains downloaded archives needed for flashingflashcontains extracted folders that are needed for flashing. Those are folders fromdownloaddir + some nvidia and airvolute scripts applied, so the flashing environment is fully ready.
To add features easily to the device without need of the creation of a new rootfs it is possible to utilize local overlays. These overlays are processed during the run of the dcs_deploy.
The local overlays are stored in the local/overlays directory. Each overlay is a either a directory or a file containing the following structure:
# Directory
overlay_name/
├─ resources/
├─ apply_overlay_name.sh
# File
overlay_name.sh
The logic of the overlay is stored in the apply_overlay_name.sh file or a overlay_name.sh for script overlay. This file is executed during the run of the dcs_deploy script. Usually, the overlay modify the rootfs that will be flashed in some way, but the logic can be anything that is needed. Each overlay is called with the same arguments as the dcs_deploy script.
Overlay can be added to the flashing configuration by adding the overlay name to the local_overlays list in the config_db.json file. The order of the overlays in the list is the order in which the overlays are applied.
The local_overlays example:
"local_overlays": ["dcs_first_boot", "hardware_support_layer", "save_version.sh"]
Third party overlays can be created and can be added to the local/overlays directory and added to the config_db.json. This is the easiest way to add new features to the device without the need to create a new rootfs. This is especially useful for the development of new features or for the testing of new features.
The overlays are called with the same positional arguments as the dcs_deploy script. Additionally, user can pass custom named arguments to the local overlay. To pass the custom arguments you need to adhere to this syntax and update the config_db.json file like this:
"local_overlays": [{"custom_arguments_showcase.sh": {"custom_arg1": "value1", "custom_arg2": "value2"}}, "dcs_first_boot", "hardware_support_layer", "save_version.sh"],
To try this out you can add [{"custom_arguments_showcase.sh": {"custom_arg1": "value1", "custom_arg2": "value2"}} to the local_overlays list in the config_db.json file to some configuration. The custom_arguments_showcase.sh will print out all the arguments passed to it in local overlay install phase.
dcs_first_boot- sets some basic settings on the device, regenerate SSH keys, enable services fromhardware_support_layer. This service is run only once, at the first boot of the device.hardware_support_layer- a set of services, udevs and other tools that are run at the first boot of the device. These services are responsible for setting up the hardware to work properly with the Airvolute DroneCore boards. All the software and configuration files installed by this layer can be reviewed in the logs folder on the device (/home/dcs_user/Airvolute/logs/dcs-deploy/dcs_deploy_data.json).save_version.sh- saves the version of the flashed configuration to the/home/dcs_user/Airvolute/logs/dcs-deploy/dcs_deploy_version.jsonfile. This file is used to store the information about the flashed configuration. This information can be used to check the version of the flashed configuration on the device.
This layer consist of two local overlays dcs_first_boot and hardware_support_layer. hardware_support_layer is a set of services, udevs and other tools that are run at the first boot of the device.
ethernet_switch_control,usb_hub_control, andusb3_controlare additional services that activate or reinitialize some hardware modules to ensure stable functionality during power cycles. By default, users do not need to modify these services in any way.boost_clocks_and_fanis another extra service that boosts clocks and activates the fan to 100%. If this behavior is undesired, it can be disabled with the commandsudo systemctl disable fan_control.- On DCS 1.0 and 1.2,
ethernet_switch_controlwill reset the USB hub. This is not an issue, but if undesired, it can be disabled similarly to fan_control.
- Currently, the connection to the Cube is not set up by default.
- We recommend using the tool
mavlink-router- https://github.com/mavlink-router/mavlink-router.- When using
mavlink-router, you can specify a connection to the Cube and then define endpoints to which the router should route Mavlink messages (your GCS IP and port). - This configuration is defined in the
main.conffile (default location at/etc/mavlink-router/main.conf). - Example content of the
main.conffile to enable GCS forwarding:
- When using
[General]
DebugLogLevel = info
TcpServerPort = 0
# Leave to TCP if using SITL
# Main connection to AutoPilot
[UartEndpoint cube]
Device = /dev/ttyTHS0
Baud = 921600
# Note that this is for communication through dev micro USB.
# if you want to use any other interface, change address accordingly.
[UdpEndpoint GCS]
Mode = Normal
Address = 192.168.55.100
Port = 14550
- When the script is re-ran, flash config folder is deleted and the files are extracted again.
- The database of configs is held inside this repository, which is not ideal.
- Download folder is not checked, only
downloaded_versions.jsonfile is, so if the download folder has been altered script will throw an error. - Errors that might occur during deployment process are not handled very well at the moment.
To verify, that the full deployment is sucesfull and that the first boot configuration is done you can run these commands on target:
During 1st boot (right after the flashing is completed):
$ journalctl -u dcs_first_boot
Expected outcome (at the end, you can also check each command's output):
dcs systemd[1]: dcs_first_boot.service: Succeeded.
After 1st boot.
sudo uhubctl
Expected outcome:
List of usb hub port with port 6 disabled.
If the output is not as expected, please reboot the device and run after 1st boot command. If the issue with usbhub is persistent please reflash the device.
- Check if the correct hardware revision of DCS was selected.
- If the device is not booting from NVME, please try to reflash the device using EMMC internal memory and flash again NVME configuration. (only Xavier NX)
On new host kernels, USB flashing problems can happen eg.: ERROR: might be timeout in USB write. see listing 1). New kernels have enabled USB autosuspend functionality which causes flashing errors. Use following commands to stop usb autosuspend:
$ sudo su
# echo -1 > /sys/module/usbcore/parameters/autosuspend
- Listing 1)
1)
Entering RCM boot
[ 0.0378 ] mb1_t234_prod_aligned_sigheader.bin.encrypt filename is from --mb1_bin
[ 0.0378 ] psc_bl1_t234_prod_aligned_sigheader.bin.encrypt filename is from --psc_bl1_bin
[ 0.0378 ] rcm boot with presigned binaries
[ 0.0384 ] tegrarcm_v2 --instance 6-2.4 --new_session --chip 0x23 0 --uid --download bct_br br_bct_BR.bct --download mb1 mb1_t234_prod_aligned_sigheader.bin.encrypt --download psc_bl1 psc_bl1_t234_prod_aligned_sigheader.bin.encrypt --download bct_mb1 mb1_bct_MB1_sigheader.bct.encrypt
[ 0.0389 ] BR_CID: 0x80012344705DD190400000000F0201C0
[ 0.1299 ] Sending bct_br
[ 0.1454 ] ERROR: might be timeout in USB write.
At the moment it is not possible to downgrade directly from JP 6.2 to JP 5.1.2, because all the UEFI, QSPI and rootfs must be compatible and there seems to be some leftovers from JP 6.2 flash.
Beware the downgrading takes just under 60 minutes.
The procedure to sucesfully downgrade is as follows:
- Start flash with JP 5.1.2 configuration.
- Wait for the flash to finish. You don't have to connect device to the host PC, we just need to create the flashing environment with images.
- Locate the
Linux_for_tegrafolder in the path~/.dcs_deploy/flash/<config_name>/Linux_for_tegra. (for example $HOME/.dcs_deploy/flash/orin_nx_nvme_2.0_default_512_full/Linux_for_Tegra) - Run the following commands for Orin NX (Orin NX should be in recovery mode and power cycle is assumed between commands) and DCS 2.0:
1. Wait until finished.
sudo ./flash.sh -c bootloader/t186ref/cfg/flash_t234_qspi.xml airvolute-dcs2.0+p3767-0000 internal
or
sudo ./flash.sh -c bootloader/t186ref/cfg/flash_t234_qspi.xml airvolute-dcs1.2+p3767-0000 internal
2. Wait until finished (even error is ok).
sudo ./tools/kernel_flash/l4t_initrd_flash.sh --erase-all --external-device nvme0n1p1 -c tools/kernel_flash/flash_l4t_external.xml --showlogs --network usb0 airvolute-dcs2.0+p3767-0000 nvme0n1p1
or
sudo ./tools/kernel_flash/l4t_initrd_flash.sh --erase-all --external-device nvme0n1p1 -c tools/kernel_flash/flash_l4t_external.xml --showlogs --network usb0 airvolute-dcs1.2+p3767-0000 nvme0n1p1
- After the 2nd flash is finished, you might need to reflash the device with the JP 5.1.2 configuration one more time using standard
dcs-deploycommand. If were using the same configuration to downgrade to JP 5.1.2, you need to use--regenflag to be sure, that the images are the ones from the configuration. After this flash you can use the device anddcs-deployas usual.
Instead of replacing the entire device tree in /boot/dtb/ you can apply overlays, which can be easily switched and disabled.
You can apply the overlays with this Nvidia provided script: sudo python /opt/nvidia/jetson-io/jetson-io.py.
Example:
In the menu, navigate to: Configure Airvolute DCS2 Adapter Board → Configure for Compatible Hardware
From the list, select the overlay you wish to use.
Confirm your selection and reboot for the changes to take effect.
By default we ship DCS with these overlays:
- IMX219 (CSI 0)
- IMX477 (CSI 0)
- OV9281 (CSI 0)
- NextVision/TC358743 HDMI capture chip (CSI 2/3)
- OV64B40 Airvolute Hadron Expander (CSI 2/3)
- Patron FPV - IMX219 (CSI 0) + OV9281 (CSI 1) + Framos IMX678 (CSI 2/3)
- Patron FPV - IMX219 (CSI 0) + OV9281 (CSI 1) + Framos IMX838 (CSI 2/3)
- Patron FPV - IMX219 (CSI 0) + OV9281 (CSI 1) + Framos IMX900 (CSI 2/3)
- OV64B40 Airvolute Hadron Expander (CSI A)
- OV9281 (CSI A)
- IMX219 (CSI A)
- Stribog - Stereo OV9281 (CSI A & CSI C) + OV9281 (CSI B) + OV64B40 Hadron (CSI F)
- Stribog - Stereo OV9281 (CSI A & CSI C) + OV9281 (CSI B) + NextVision (CSI F)
DCS2.Pilot boards use the Cube autopilot by default when supported. If your board does not have a Cube installed, or you want to use the onboard FMU instead, apply the internal FMU overlay.
sudo python /opt/nvidia/jetson-io/jetson-io.py.
In the menu, navigate to: Airvolute DCS2 Pilot FMU → Configure for Compatible Hardware → Internal FMU
Multiple overlays must be applied at the same time. If you apply and save the camera overlay first, then run
jetson-io.pyagain to apply the FMU overlay, the previously applied camera overlay will be overwritten. Make sure to select and apply both the camera and FMU overlays in a single configuration step.
On both DCS 1.2 and DCS 2.0 boards, a temperature sensor is connected to the I2C-1 bus. It's temperature can be read from this path: /sys/class/hwmon/hwmon0/temp1_input. The read value is in millicelsius [m°C] (a returned value of 47000 = 47°C).
DCS 2.0 includes a BMI088 IMU, which combines a 3-axis accelerometer (max 1600 Hz) and a 3-axis gyroscope (max 2000 Hz). These sensors can be accessed and configured via the Industrial I/O (IIO) subsystem under the following paths:
- Accelerometer:
/sys/bus/iio/devices/iio:device0 - Gyroscope:
/sys/bus/iio/devices/iio:device1
DCS2.Pilot rev.2 board includes a ATTPM20P chip, which can be accessed as /dev/spidev1.3
SPI access is available, however no TPM driver or functionality has been implemented yet.
- Super modes are fully supported on all boards when using the Jetson Orin Nano 4GB.
- For Jetson Orin NX 16GB, super modes are recommended only with the newer DCS2.Default Expansion board. Earlier DCS2.PDB default power boards and DCS 1.2 Pilot boards may not consistently provide the required power for Orin NX in super modes, which can lead to overheating or unexpected shutdowns.
- When using Jetson Orin NX 16GB in super modes, sufficient cooling is required to prevent overheating.
- If you plan to use super modes, please contact Airvolute support for compatibility details, usage recommendations, and recommended heatsink and thermal solutions.
- OV9281
- IMX219
- IMX477
- NextVision/TC358743 HDMI capture
- OV64B40 Airvolute Hadron Expander
- Arducam Jetvariety
- Framos IMX662
- Framos IMX676
- Framos IMX900
- Framos IMX678
- Framos IMX838
Starting with JP6, we include by default ethernet_switch_control.py script, which configures the internal DCS2.Pilot Ethernet switch to resolve known ethernet issues.
- Added driver support for Framos cameras.
- Added driver support for Arducam Jetvariety cameras.
- Added Wireguard module into kernel.
- Added DT Overlays for Stribog, Patron FPV, Internal FMU switch.
- Removed cvb eeprom dependency.
- Added Real Time Clock support DS1388 for DCS2.Pilot rev.2 board.
- DCS 1.2 Support.
- Super modes added.
- Added SPI communication support for the TPM 2.0 ATTPM20P on DCS2.Pilot rev.2 board.
- Added driver support for IMU BMI088.