diff --git a/.gitignore b/.gitignore index 05297f8..2536e6a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,3 @@ *.ignore testbuild.sh -a.so +*.so diff --git a/README.md b/README.md index 4d723d9..46ca8ff 100644 --- a/README.md +++ b/README.md @@ -10,15 +10,16 @@ implemented by the calling program. 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 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 `int32_t nrai_can_mkframe_(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_(struct nrai_can_ai_read *, struct can_frame *);`. 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_` +all entries are named in the format `NRAI_CAN_ID_`, As well as enums +for values contained within frames (see header file). ## Notes -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 +This API makes use of limited use of C23 extensions where their use either +improves clarity or simplifies code. While all C23 extensions used are supported by GCC and Clang, not all compilers support them. diff --git a/meson.build b/meson.build new file mode 100644 index 0000000..f1906b1 --- /dev/null +++ b/meson.build @@ -0,0 +1,8 @@ +project('nrai_CAN_API', 'C') +lib = static_library('nrai_CAN_API','nrai_CAN_API.c', install : true) + +pkg = import('pkgconfig') +install_headers('nrai_CAN_API.h') +pkg.generate(lib, +# version : '1.1', + description : 'the nrai api to pack and unpack CAN frames from the ADS-DV Software Interface Specification into simpler data structures ') diff --git a/nrai_CAN_API.h b/nrai_CAN_API.h index fdafde2..cf5e684 100644 --- a/nrai_CAN_API.h +++ b/nrai_CAN_API.h @@ -165,6 +165,7 @@ enum{ /* VCU2AI_Status: AS_STATE*/ enum{ + AS_STATE_AS_INIT = 0, AS_STATE_AS_OFF = 1, AS_STATE_AS_READY = 2, AS_STATE_AS_DRIVING = 3,