newcastle-racing/nrai_ADS-DV_CAN-API
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Its time to retire

Browse source
This commit is contained in:
RowanC 2026-04-06 17:34:24 +01:00
parent 0a6ebedd84
commit 6725e53d45
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -1,4 +1,4 @@
= nrai_ADS-DV_CAN-API # nrai_ADS-DV_CAN-API
This is the Newcastle Racing AI (nrai) implementation of the ADS-DV software This is the Newcastle Racing AI (nrai) implementation of the ADS-DV software
interface specification (including all other sensors accessed via CAN e.g. GPS). interface specification (including all other sensors accessed via CAN e.g. GPS).
it aims to be as minimal as possible, facilitating on the bare minimum to pack it aims to be as minimal as possible, facilitating on the bare minimum to pack
@ -6,7 +6,7 @@ and unpack CAN frames, only implementing checks where required for the packing
of frames (e.g. stat clamping). All data sanity checks are expected to be of frames (e.g. stat clamping). All data sanity checks are expected to be
implemented by the calling program. implemented by the calling program.
== Usage ## Usage
This API provides 2 structs for storing data to be written to, and received from This API provides 2 structs for storing data to be written to, and received from
the VCU over CAN. They are `nrai_can_ai_read` and `nrai_can_ai_write` for data the VCU over CAN. They are `nrai_can_ai_read` and `nrai_can_ai_write` for data
received from the VCU and data to write to the VCU respectively. received from the VCU and data to write to the VCU respectively.
@ -18,7 +18,7 @@ and function for the AI to unpack CAN frames, named in the format
This API also provides an enum for translating CAN message names into their ID, This API also provides an enum for translating CAN message names into their ID,
all entry's are named in the format `NRAI_CAN_ID_<frame_name>` all entry's are named in the format `NRAI_CAN_ID_<frame_name>`
== Notes ## Notes
This API makes use of limited use of C23 extensions for the purpose of either This API makes use of limited use of C23 extensions for the purpose of either
improving clarity or simplifying code. While all C23 extensions used are improving clarity or simplifying code. While all C23 extensions used are
supported by GCC and Clang, not all compilers support them. supported by GCC and Clang, not all compilers support them.