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

Spelling and wording changes

Browse source
This commit is contained in:
RowanC 2026-11-11 22:55:59 +00:00
parent 83fac395d9
commit 2063d3f5f6
Signed by: RowanC
GPG key ID: 77742A503A3B2AC8
1 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -10,15 +10,16 @@ implemented by the calling program.
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.
This API provides functions for the AI to pack data into CAN frames, named in This API provides functions for the client to pack data into CAN frames, named in
the format the format
`int32_t nrai_can_mkframe_<frame_name>(struct nrai_can_ai_write *, struct can_frame *);` `int32_t nrai_can_mkframe_<frame_name>(struct nrai_can_ai_write *, struct can_frame *);`
and function for the AI to unpack CAN frames, named in the format and functions for the client to unpack CAN frames, named in the format
`int32_t nrai_can_unpack_<frame_name>(struct nrai_can_ai_read *, struct can_frame *);`. `int32_t nrai_can_unpack_<frame_name>(struct nrai_can_ai_read *, struct can_frame *);`.
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 entries are named in the format `NRAI_CAN_ID_<frame_name>`, As well as enums
for values contained within frames (see header file).
## 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 where their use either
improving clarity or simplifying code. While all C23 extensions used are improves clarity or simplifies 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.