Skip to content
The UAVCAN specification documents are maintained here.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dsdl @ b571868
specification Cleaned up the front matter; no changes to the text May 9, 2019
.gitignore
.gitlab-ci.yml
.gitmodules
LICENSE Initial source input; mostly empty still Jun 29, 2018
README.md
clean.sh Moved the compilation and clean scripts into the top-level directory … May 8, 2019
compile.sh Moved the compilation and clean scripts into the top-level directory … May 8, 2019
render_dsdl.py Update render_dsdl.py for compatibility with PyDSDL v0.7 (which is ne… Apr 26, 2019
render_list_of_void_and_primitive_types.py
requirements.txt

README.md

UAVCAN specification

Forum

The sources of the UAVCAN specification and other related documents are contained here.

When cloning this repository, don't forget to initialize the Git submodules: git submodule update --init --recursive.

Compiling

A GNU/Linux-based operating system is assumed. The described instructions may be valid for other operating systems but this is not guaranteed.

In order to compile the document, install TexLive (Debian-based APT packages: texlive-full lyx) and the following Python packages:

  • pygments (for Debian-based systems, use APT package python-pygments)
  • pydsdl

When done, run ./compile.sh.

Editing

First, ensure that you can compile the document as described above. Do not proceeed further until that requirement is satisfied.

Use Visual Studio Code with extensions James-Yu.latex-workshop and ban.spellright for editing. More info in the Zubax Knowledge Base.

If you're using Visual Studio Code, the following settings for James-Yu.latex-workshop may be useful (paste them into your user config file):

{
    "latex-workshop.view.pdf.hand": true,
    "latex-workshop.latex.recipes": [
        {
            "name": "pdflatex x3",
            "tools": [
                "pdflatex",
                "pdflatex",
                "pdflatex"
            ]
        }
    ],
    "latex-workshop.latex.tools": [
        {
            "name": "pdflatex",
            "command": "pdflatex",
            "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "--halt-on-error",
                "--shell-escape",
                "%DOC%"
            ]
        },
        {
            "name": "bibtex",
            "command": "bibtex",
            "args": [
                "%DOCFILE%"
            ]
        }
    ]
}

Add the following user dictionary file to squelch bogus spelling errors from Spellright: https://gist.github.com/pavel-kirienko/bd3ecf47fbdb164baeb408af31100f7d. Do not edit the document without the spell checker.

License

All data contained herein is distributed under the terms of the Creative Commons Attribution 4.0 International license (CC BY 4.0), unless explicitly stated otherwise.

You can’t perform that action at this time.