sven
/
libicsneo
mirror of https://github.com/intrepidcs/libicsneo.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

commonize the naming of the functions

David Rebbe 2024-12-05 16:19:32 -05:00
parent a2feff5dbd
commit 7e4c0cdc43
4 changed files with 63 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
api/icsneo/icsneo.cpp
View File

@ -90,7 +90,7 @@ ICSNEO_API icsneo_error_t icsneo_device_type_from_type(icsneo_devicetype_t devic
return icsneo_error_success; return icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_find(icsneo_device_t** devices, uint32_t* devices_count, void* reserved) { ICSNEO_API icsneo_error_t icsneo_device_find_all(icsneo_device_t** devices, uint32_t* devices_count, void* reserved) {
if (!devices || !devices_count) { if (!devices || !devices_count) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -136,7 +136,7 @@ ICSNEO_API icsneo_error_t icsneo_device_is_valid(icsneo_device_t* device) {
return !device->device ? icsneo_error_invalid_parameters : icsneo_error_success; return !device->device ? icsneo_error_invalid_parameters : icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_get_open_options(icsneo_device_t* device, icsneo_open_options_t* options) { ICSNEO_API icsneo_error_t icsneo_device_get_open_options(icsneo_device_t* device, icsneo_open_options_t* options) {
if (!device || !options) { if (!device || !options) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -145,7 +145,7 @@ ICSNEO_API icsneo_error_t icsneo_get_open_options(icsneo_device_t* device, icsne
return icsneo_error_success; return icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_set_open_options(icsneo_device_t* device, icsneo_open_options_t options) { ICSNEO_API icsneo_error_t icsneo_device_set_open_options(icsneo_device_t* device, icsneo_open_options_t options) {
if (!device) { if (!device) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -155,7 +155,7 @@ ICSNEO_API icsneo_error_t icsneo_set_open_options(icsneo_device_t* device, icsne
return icsneo_error_success; return icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_open(icsneo_device_t* device) { ICSNEO_API icsneo_error_t icsneo_device_open(icsneo_device_t* device) {
if (!device || !device->device) { if (!device || !device->device) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -188,7 +188,7 @@ ICSNEO_API icsneo_error_t icsneo_open(icsneo_device_t* device) {
return icsneo_error_success; return icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_close(icsneo_device_t* device) { ICSNEO_API icsneo_error_t icsneo_device_close(icsneo_device_t* device) {
if (!device || !device->device) { if (!device || !device->device) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -205,7 +205,7 @@ ICSNEO_API icsneo_error_t icsneo_close(icsneo_device_t* device) {
return icsneo_error_success; return icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_device_describe(icsneo_device_t* device, const char* value, uint32_t* value_length) { ICSNEO_API icsneo_error_t icsneo_device_get_description(icsneo_device_t* device, const char* value, uint32_t* value_length) {
if (!device || !device->device) { if (!device || !device->device) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -219,7 +219,7 @@ ICSNEO_API icsneo_error_t icsneo_device_describe(icsneo_device_t* device, const
return icsneo_error_success; return icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_device_type(icsneo_device_t* device, icsneo_devicetype_t* value) { ICSNEO_API icsneo_error_t icsneo_device_get_type(icsneo_device_t* device, icsneo_devicetype_t* value) {
if (!device || !device->device) { if (!device || !device->device) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -229,7 +229,7 @@ ICSNEO_API icsneo_error_t icsneo_device_type(icsneo_device_t* device, icsneo_dev
return icsneo_error_success; return icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_device_serial(icsneo_device_t* device, const char* value, uint32_t* value_length) { ICSNEO_API icsneo_error_t icsneo_device_get_serial(icsneo_device_t* device, const char* value, uint32_t* value_length) {
if (!device || !device->device) { if (!device || !device->device) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -244,7 +244,7 @@ ICSNEO_API icsneo_error_t icsneo_device_serial(icsneo_device_t* device, const ch
} }
ICSNEO_API icsneo_error_t icsneo_go_online(icsneo_device_t* device, bool go_online) { ICSNEO_API icsneo_error_t icsneo_device_go_online(icsneo_device_t* device, bool go_online) {
if (!device) { if (!device) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -261,7 +261,7 @@ ICSNEO_API icsneo_error_t icsneo_go_online(icsneo_device_t* device, bool go_onli
return icsneo_error_go_online_failed; return icsneo_error_go_online_failed;
} }
ICSNEO_API icsneo_error_t icsneo_is_online(icsneo_device_t* device, bool* is_online) { ICSNEO_API icsneo_error_t icsneo_device_is_online(icsneo_device_t* device, bool* is_online) {
if (!device || !is_online) { if (!device || !is_online) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -271,7 +271,7 @@ ICSNEO_API icsneo_error_t icsneo_is_online(icsneo_device_t* device, bool* is_onl
return icsneo_error_success; return icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_is_online_supported(icsneo_device_t* device, bool* is_online_supported) { ICSNEO_API icsneo_error_t icsneo_device_is_online_supported(icsneo_device_t* device, bool* is_online_supported) {
if (!device || !is_online_supported) { if (!device || !is_online_supported) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -281,7 +281,7 @@ ICSNEO_API icsneo_error_t icsneo_is_online_supported(icsneo_device_t* device, bo
return icsneo_error_success; return icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_set_message_polling(icsneo_device_t* device, bool enable) { ICSNEO_API icsneo_error_t icsneo_device_set_message_polling(icsneo_device_t* device, bool enable) {
if (!device) { if (!device) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -298,7 +298,7 @@ ICSNEO_API icsneo_error_t icsneo_set_message_polling(icsneo_device_t* device, bo
return icsneo_error_enable_message_polling_failed; return icsneo_error_enable_message_polling_failed;
} }
ICSNEO_API icsneo_error_t icsneo_get_message_polling(icsneo_device_t* device, bool* is_enabled) { ICSNEO_API icsneo_error_t icsneo_device_get_message_polling(icsneo_device_t* device, bool* is_enabled) {
if (!device || !is_enabled) { if (!device || !is_enabled) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -308,7 +308,7 @@ ICSNEO_API icsneo_error_t icsneo_get_message_polling(icsneo_device_t* device, bo
return icsneo_error_success; return icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_set_message_polling_limit(icsneo_device_t* device, uint32_t limit) { ICSNEO_API icsneo_error_t icsneo_device_set_message_polling_limit(icsneo_device_t* device, uint32_t limit) {
if (!device) { if (!device) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -318,7 +318,7 @@ ICSNEO_API icsneo_error_t icsneo_set_message_polling_limit(icsneo_device_t* devi
return icsneo_error_success; return icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_get_message_polling_limit(icsneo_device_t* device, uint32_t* limit) { ICSNEO_API icsneo_error_t icsneo_device_get_message_polling_limit(icsneo_device_t* device, uint32_t* limit) {
if (!device || !limit) { if (!device || !limit) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -328,7 +328,7 @@ ICSNEO_API icsneo_error_t icsneo_get_message_polling_limit(icsneo_device_t* devi
return icsneo_error_success; return icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_get_message_count(icsneo_device_t* device, uint32_t* count) { ICSNEO_API icsneo_error_t icsneo_device_get_message_count(icsneo_device_t* device, uint32_t* count) {
if (!device || !count) { if (!device || !count) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -338,7 +338,7 @@ ICSNEO_API icsneo_error_t icsneo_get_message_count(icsneo_device_t* device, uint
return icsneo_error_success; return icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_get_timestamp_resolution(icsneo_device_t* device, uint32_t* resolution) { ICSNEO_API icsneo_error_t icsneo_device_get_timestamp_resolution(icsneo_device_t* device, uint32_t* resolution) {
if (!device || !resolution) { if (!device || !resolution) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -348,7 +348,7 @@ ICSNEO_API icsneo_error_t icsneo_get_timestamp_resolution(icsneo_device_t* devic
return icsneo_error_success; return icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_get_messages(icsneo_device_t* device, icsneo_message_t** messages, uint32_t* messages_count, uint32_t timeout_ms) { ICSNEO_API icsneo_error_t icsneo_device_get_messages(icsneo_device_t* device, icsneo_message_t** messages, uint32_t* messages_count, uint32_t timeout_ms) {
if (!device || !messages || !messages_count) { if (!device || !messages || !messages_count) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -391,7 +391,7 @@ ICSNEO_API icsneo_error_t icsneo_get_messages(icsneo_device_t* device, icsneo_me
return icsneo_error_success; return icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_is_message_valid(icsneo_device_t* device, icsneo_message_t* message, bool* is_valid) { ICSNEO_API icsneo_error_t icsneo_message_is_valid(icsneo_device_t* device, icsneo_message_t* message, bool* is_valid) {
if (!device || !message || !is_valid) { if (!device || !message || !is_valid) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -454,7 +454,7 @@ ICSNEO_API icsneo_error_t icsneo_message_get_data(icsneo_device_t* device, icsne
} }
ICSNEO_API icsneo_error_t icsneo_can_message_arbid(icsneo_device_t* device, icsneo_message_t* message, uint32_t* value) { ICSNEO_API icsneo_error_t icsneo_can_message_get_arbid(icsneo_device_t* device, icsneo_message_t* message, uint32_t* value) {
if (!device || !message || !value) { if (!device || !message || !value) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -470,7 +470,7 @@ ICSNEO_API icsneo_error_t icsneo_can_message_arbid(icsneo_device_t* device, icsn
return icsneo_error_success; return icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_can_message_dlc_on_wire(icsneo_device_t* device, icsneo_message_t* message, uint32_t* value) { ICSNEO_API icsneo_error_t icsneo_can_message_get_dlc_on_wire(icsneo_device_t* device, icsneo_message_t* message, uint32_t* value) {
if (!device || !message || !value) { if (!device || !message || !value) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -534,7 +534,7 @@ ICSNEO_API icsneo_error_t icsneo_can_message_is_canfd(icsneo_device_t* device, i
return icsneo_error_success; return icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_can_message_baudrate_switch(icsneo_device_t* device, icsneo_message_t* message, bool* value) { ICSNEO_API icsneo_error_t icsneo_can_message_get_baudrate_switch(icsneo_device_t* device, icsneo_message_t* message, bool* value) {
if (!device || !message || !value) { if (!device || !message || !value) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }
@ -550,7 +550,7 @@ ICSNEO_API icsneo_error_t icsneo_can_message_baudrate_switch(icsneo_device_t* de
return icsneo_error_success; return icsneo_error_success;
} }
ICSNEO_API icsneo_error_t icsneo_can_message_error_state_indicator(icsneo_device_t* device, icsneo_message_t* message, bool* value) { ICSNEO_API icsneo_error_t icsneo_can_message_get_error_state_indicator(icsneo_device_t* device, icsneo_message_t* message, bool* value) {
if (!device || !message || !value) { if (!device || !message || !value) {
return icsneo_error_invalid_parameters; return icsneo_error_invalid_parameters;
} }

20
examples/c/simple/src/main.c
View File

@ -70,7 +70,7 @@ int main(int argc, char* argv[]) {
icsneo_device_t* devices[255] = {0}; icsneo_device_t* devices[255] = {0};
uint32_t devices_count = 255; uint32_t devices_count = 255;
icsneo_error_t res = icsneo_find(devices, &devices_count, NULL); icsneo_error_t res = icsneo_device_find_all(devices, &devices_count, NULL);
if (res != icsneo_error_success) { if (res != icsneo_error_success) {
return print_error_code("Failed to find devices", res); return print_error_code("Failed to find devices", res);
}; };
@ -82,14 +82,14 @@ int main(int argc, char* argv[]) {
// Get description of the device // Get description of the device
const char description[255] = {0}; const char description[255] = {0};
uint32_t description_length = 255; uint32_t description_length = 255;
res = icsneo_device_describe(device, description, &description_length); res = icsneo_device_get_description(device, description, &description_length);
if (res != icsneo_error_success) { if (res != icsneo_error_success) {
print_device_events(device, description); print_device_events(device, description);
return print_error_code("Failed to get device description", res); return print_error_code("Failed to get device description", res);
}; };
// Get timestamp resolution of the device // Get timestamp resolution of the device
uint32_t timestamp_resolution = 0; uint32_t timestamp_resolution = 0;
res = icsneo_get_timestamp_resolution(device, &timestamp_resolution); res = icsneo_device_get_timestamp_resolution(device, &timestamp_resolution);
if (res != icsneo_error_success) { if (res != icsneo_error_success) {
print_device_events(device, description); print_device_events(device, description);
return print_error_code("Failed to get timestamp resolution", res); return print_error_code("Failed to get timestamp resolution", res);
@ -97,21 +97,21 @@ int main(int argc, char* argv[]) {
printf("%s timestamp resolution: %uns\n", description, timestamp_resolution); printf("%s timestamp resolution: %uns\n", description, timestamp_resolution);
// Get/Set open options // Get/Set open options
icsneo_open_options_t options = icsneo_open_options_none; icsneo_open_options_t options = icsneo_open_options_none;
res = icsneo_get_open_options(device, &options); res = icsneo_device_get_open_options(device, &options);
if (res != icsneo_error_success) { if (res != icsneo_error_success) {
print_device_events(device, description); print_device_events(device, description);
return print_error_code("Failed to get open options", res); return print_error_code("Failed to get open options", res);
} }
// Disable Syncing RTC // Disable Syncing RTC
options &= ~icsneo_open_options_sync_rtc; options &= ~icsneo_open_options_sync_rtc;
res = icsneo_set_open_options(device, options); res = icsneo_device_set_open_options(device, options);
if (res != icsneo_error_success) { if (res != icsneo_error_success) {
print_device_events(device, description); print_device_events(device, description);
return print_error_code("Failed to set open options", res); return print_error_code("Failed to set open options", res);
} }
// Open the device // Open the device
printf("Opening device: %s...\n", description); printf("Opening device: %s...\n", description);
res = icsneo_open(device); res = icsneo_device_open(device);
if (res != icsneo_error_success) { if (res != icsneo_error_success) {
print_device_events(device, description); print_device_events(device, description);
return print_error_code("Failed to open device", res); return print_error_code("Failed to open device", res);
@ -123,7 +123,7 @@ int main(int argc, char* argv[]) {
icsneo_message_t* messages[20000] = {0}; icsneo_message_t* messages[20000] = {0};
uint32_t message_count = 20000; uint32_t message_count = 20000;
printf("Getting messages from device with timeout of 3000ms on %s...\n", description); printf("Getting messages from device with timeout of 3000ms on %s...\n", description);
res = icsneo_get_messages(device, messages, &message_count, 3000); res = icsneo_device_get_messages(device, messages, &message_count, 3000);
if (res != icsneo_error_success) { if (res != icsneo_error_success) {
print_device_events(device, description); print_device_events(device, description);
return print_error_code("Failed to get messages from device", res); return print_error_code("Failed to get messages from device", res);
@ -136,7 +136,7 @@ int main(int argc, char* argv[]) {
} }
// Finally, close the device. // Finally, close the device.
printf("Closing device: %s...\n", description); printf("Closing device: %s...\n", description);
res = icsneo_close(device); res = icsneo_device_close(device);
if (res != icsneo_error_success) { if (res != icsneo_error_success) {
print_device_events(device, description); print_device_events(device, description);
return print_error_code("Failed to close device", res); return print_error_code("Failed to close device", res);
@ -215,8 +215,8 @@ int process_messages(icsneo_device_t* device, icsneo_message_t** messages, uint3
bool is_extended = false; bool is_extended = false;
uint8_t data[64] = {0}; uint8_t data[64] = {0};
uint32_t data_length = 64; uint32_t data_length = 64;
uint32_t result = icsneo_can_message_arbid(device, message, &arbid); uint32_t result = icsneo_can_message_get_arbid(device, message, &arbid);
result += icsneo_can_message_dlc_on_wire(device, message, &dlc); result += icsneo_can_message_get_dlc_on_wire(device, message, &dlc);
result += icsneo_can_message_is_remote(device, message, &is_remote); result += icsneo_can_message_is_remote(device, message, &is_remote);
result += icsneo_can_message_is_canfd(device, message, &is_canfd); result += icsneo_can_message_is_canfd(device, message, &is_canfd);
result += icsneo_can_message_is_extended(device, message, &is_extended); result += icsneo_can_message_is_extended(device, message, &is_extended);

58
include/icsneo/icsneo.h
View File

@ -124,7 +124,7 @@ ICSNEO_API icsneo_error_t icsneo_device_type_from_type(icsneo_devicetype_t devic
* *
* @return icsneo_error_t icsneo_error_success if successful. * @return icsneo_error_t icsneo_error_success if successful.
*/ */
ICSNEO_API icsneo_error_t icsneo_find(icsneo_device_t** devices, uint32_t* devices_count, void* reserved); ICSNEO_API icsneo_error_t icsneo_device_find_all(icsneo_device_t** devices, uint32_t* devices_count, void* reserved);
/** @brief Check to make sure a device is valid. /** @brief Check to make sure a device is valid.
* *
@ -141,7 +141,7 @@ ICSNEO_API icsneo_error_t icsneo_device_is_valid(icsneo_device_t* device);
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_get_open_options(icsneo_device_t* device, icsneo_open_options_t* options); ICSNEO_API icsneo_error_t icsneo_device_get_open_options(icsneo_device_t* device, icsneo_open_options_t* options);
/** @brief Set the open options for a device /** @brief Set the open options for a device
* *
@ -150,31 +150,31 @@ ICSNEO_API icsneo_error_t icsneo_get_open_options(icsneo_device_t* device, icsne
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_set_open_options(icsneo_device_t* device, icsneo_open_options_t options); ICSNEO_API icsneo_error_t icsneo_device_set_open_options(icsneo_device_t* device, icsneo_open_options_t options);
/** @brief Open a connection to a device. /** @brief Open a connection to a device.
* *
* After a successful call to this function, icsneo_close() must be called to close the device. * After a successful call to this function, icsneo_device_close() must be called to close the device.
* *
* @param[in] icsneo_device_t device The device to open. * @param[in] icsneo_device_t device The device to open.
* @param[out] icsneo_handle_t* handle Pointer to a handle to the opened device. Will be NULL on failure. * @param[out] icsneo_handle_t* handle Pointer to a handle to the opened device. Will be NULL on failure.
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_failure otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_failure otherwise.
* *
* @see icsneo_close * @see icsneo_device_close
*/ */
ICSNEO_API icsneo_error_t icsneo_open(icsneo_device_t* device); ICSNEO_API icsneo_error_t icsneo_device_open(icsneo_device_t* device);
/** @brief Close a connection to a previously opened device. /** @brief Close a connection to a previously opened device.
* *
* After a successful call to icsneo_open(), this function must be called to close the device. * After a successful call to icsneo_device_open(), this function must be called to close the device.
* An already closed device will still succeed. * An already closed device will still succeed.
* *
* @param[in] icsneo_device_t device The device to close. * @param[in] icsneo_device_t device The device to close.
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_failure otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_failure otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_close(icsneo_device_t* device); ICSNEO_API icsneo_error_t icsneo_device_close(icsneo_device_t* device);
/** @brief Get the description of a device /** @brief Get the description of a device
* *
@ -184,16 +184,16 @@ ICSNEO_API icsneo_error_t icsneo_close(icsneo_device_t* device);
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_device_describe(icsneo_device_t* device, const char* value, uint32_t* value_length); ICSNEO_API icsneo_error_t icsneo_device_get_description(icsneo_device_t* device, const char* value, uint32_t* value_length);
/** @brief Get the description type a device /** @brief Get the type of a device
* *
* @param[in] icsneo_device_t device The device to get the description of. * @param[in] icsneo_device_t device The device to get the type of.
* @param[out] icsneo_devicetype_t* value Pointer to an icsneo_devicetype_t to copy the type into. * @param[out] icsneo_devicetype_t* value Pointer to an icsneo_devicetype_t to copy the type into.
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_device_type(icsneo_device_t* device, icsneo_devicetype_t* value); ICSNEO_API icsneo_error_t icsneo_device_get_type(icsneo_device_t* device, icsneo_devicetype_t* value);
/** @brief Get the serial of a device /** @brief Get the serial of a device
* *
@ -203,7 +203,7 @@ ICSNEO_API icsneo_error_t icsneo_device_type(icsneo_device_t* device, icsneo_dev
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_device_serial(icsneo_device_t* device, const char* value, uint32_t* value_length); ICSNEO_API icsneo_error_t icsneo_device_get_serial(icsneo_device_t* device, const char* value, uint32_t* value_length);
/** @brief Set the online state of a device. /** @brief Set the online state of a device.
* *
@ -212,7 +212,7 @@ ICSNEO_API icsneo_error_t icsneo_device_serial(icsneo_device_t* device, const ch
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_go_online(icsneo_device_t* device, bool go_online); ICSNEO_API icsneo_error_t icsneo_device_go_online(icsneo_device_t* device, bool go_online);
/** @brief Get the online state of a device. /** @brief Get the online state of a device.
* *
@ -221,7 +221,7 @@ ICSNEO_API icsneo_error_t icsneo_go_online(icsneo_device_t* device, bool go_onli
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_is_online(icsneo_device_t* device, bool* is_online); ICSNEO_API icsneo_error_t icsneo_device_is_online(icsneo_device_t* device, bool* is_online);
/** @brief Get the online supported state of a device. /** @brief Get the online supported state of a device.
* *
@ -230,7 +230,7 @@ ICSNEO_API icsneo_error_t icsneo_is_online(icsneo_device_t* device, bool* is_onl
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_is_online_supported(icsneo_device_t* device, bool* is_online_supported); ICSNEO_API icsneo_error_t icsneo_device_is_online_supported(icsneo_device_t* device, bool* is_online_supported);
/** @brief Set the message polling state of a device. /** @brief Set the message polling state of a device.
@ -240,7 +240,7 @@ ICSNEO_API icsneo_error_t icsneo_is_online_supported(icsneo_device_t* device, bo
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_set_message_polling(icsneo_device_t* device, bool enable); ICSNEO_API icsneo_error_t icsneo_device_set_message_polling(icsneo_device_t* device, bool enable);
/** @brief Get the message polling state of a device. /** @brief Get the message polling state of a device.
* *
@ -249,7 +249,7 @@ ICSNEO_API icsneo_error_t icsneo_set_message_polling(icsneo_device_t* device, bo
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_get_message_polling(icsneo_device_t* device, bool* is_enabled); ICSNEO_API icsneo_error_t icsneo_device_get_message_polling(icsneo_device_t* device, bool* is_enabled);
/** @brief Set the message polling limit of a device. /** @brief Set the message polling limit of a device.
* *
@ -260,18 +260,18 @@ ICSNEO_API icsneo_error_t icsneo_get_message_polling(icsneo_device_t* device, bo
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_set_message_polling_limit(icsneo_device_t* device, uint32_t limit); ICSNEO_API icsneo_error_t icsneo_device_set_message_polling_limit(icsneo_device_t* device, uint32_t limit);
/** @brief Get the message polling limit of a device. /** @brief Get the message polling limit of a device.
* *
* @see icsneo_set_message_polling_limit * @see icsneo_device_set_message_polling_limit
* *
* @param[in] icsneo_device_t device The device to enforce the message polling limit. * @param[in] icsneo_device_t device The device to enforce the message polling limit.
* @param[out] uint32_t limit The limit to get. * @param[out] uint32_t limit The limit to get.
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_get_message_polling_limit(icsneo_device_t* device, uint32_t* limit); ICSNEO_API icsneo_error_t icsneo_device_get_message_polling_limit(icsneo_device_t* device, uint32_t* limit);
/** @brief Get the message count of a device /** @brief Get the message count of a device
* *
@ -280,7 +280,7 @@ ICSNEO_API icsneo_error_t icsneo_get_message_polling_limit(icsneo_device_t* devi
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_get_message_count(icsneo_device_t* device, uint32_t* count); ICSNEO_API icsneo_error_t icsneo_device_get_message_count(icsneo_device_t* device, uint32_t* count);
/** @brief Get the timestamp resolution (nanoseconds) of a device /** @brief Get the timestamp resolution (nanoseconds) of a device
@ -290,7 +290,7 @@ ICSNEO_API icsneo_error_t icsneo_get_message_count(icsneo_device_t* device, uint
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_get_timestamp_resolution(icsneo_device_t* device, uint32_t* resolution); ICSNEO_API icsneo_error_t icsneo_device_get_timestamp_resolution(icsneo_device_t* device, uint32_t* resolution);
/** @brief Get the messages of a device /** @brief Get the messages of a device
* *
@ -304,7 +304,7 @@ ICSNEO_API icsneo_error_t icsneo_get_timestamp_resolution(icsneo_device_t* devic
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_get_messages(icsneo_device_t* device, icsneo_message_t** messages, uint32_t* messages_count, uint32_t timeout_ms); ICSNEO_API icsneo_error_t icsneo_device_get_messages(icsneo_device_t* device, icsneo_message_t** messages, uint32_t* messages_count, uint32_t timeout_ms);
/** @brief Check if a message is valid /** @brief Check if a message is valid
* *
@ -314,7 +314,7 @@ ICSNEO_API icsneo_error_t icsneo_get_messages(icsneo_device_t* device, icsneo_me
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_is_message_valid(icsneo_device_t* device, icsneo_message_t* message, bool* is_valid); ICSNEO_API icsneo_error_t icsneo_message_is_valid(icsneo_device_t* device, icsneo_message_t* message, bool* is_valid);
/** @brief Get the type of a message /** @brief Get the type of a message
* *
@ -359,7 +359,7 @@ ICSNEO_API icsneo_error_t icsneo_message_get_data(icsneo_device_t* device, icsne
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_can_message_arbid(icsneo_device_t* device, icsneo_message_t* message, uint32_t* value); ICSNEO_API icsneo_error_t icsneo_can_message_get_arbid(icsneo_device_t* device, icsneo_message_t* message, uint32_t* value);
/** @brief Get the DLC on wire of a CAN message /** @brief Get the DLC on wire of a CAN message
* *
@ -369,7 +369,7 @@ ICSNEO_API icsneo_error_t icsneo_can_message_arbid(icsneo_device_t* device, icsn
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_can_message_dlc_on_wire(icsneo_device_t* device, icsneo_message_t* message, uint32_t* value); ICSNEO_API icsneo_error_t icsneo_can_message_get_dlc_on_wire(icsneo_device_t* device, icsneo_message_t* message, uint32_t* value);
/** @brief Get the remote status of a CAN message /** @brief Get the remote status of a CAN message
* *
@ -409,7 +409,7 @@ ICSNEO_API icsneo_error_t icsneo_can_message_is_canfd(icsneo_device_t* device, i
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_can_message_baudrate_switch(icsneo_device_t* device, icsneo_message_t* message, bool* value); ICSNEO_API icsneo_error_t icsneo_can_message_get_baudrate_switch(icsneo_device_t* device, icsneo_message_t* message, bool* value);
/** @brief Get the error state indicator status of a CAN message /** @brief Get the error state indicator status of a CAN message
* *
@ -419,7 +419,7 @@ ICSNEO_API icsneo_error_t icsneo_can_message_baudrate_switch(icsneo_device_t* de
* *
* @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise. * @return icsneo_error_t icsneo_error_success if successful, icsneo_error_invalid_parameters otherwise.
*/ */
ICSNEO_API icsneo_error_t icsneo_can_message_error_state_indicator(icsneo_device_t* device, icsneo_message_t* message, bool* value); ICSNEO_API icsneo_error_t icsneo_can_message_get_error_state_indicator(icsneo_device_t* device, icsneo_message_t* message, bool* value);
/** @brief Get the global events not specifically related to a device. /** @brief Get the global events not specifically related to a device.
* *

2
include/icsneo/icsneotypes.h
View File

@ -7,7 +7,7 @@ extern "C" {
#include <stdint.h> #include <stdint.h>
/** @brief /** @brief
* Options for opening a device. See icsneo_open() for more info. * Options for opening a device. See icsneo_device_open() for more info.
*/ */
typedef enum _icsneo_open_options_t { typedef enum _icsneo_open_options_t {
// No options // No options