Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Non-blocking functions #50

Merged
merged 9 commits into from
Aug 9, 2024
+1,018 −301
Merged

Non-blocking functions #50

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
eef80f3
Provide functions enabling non-blocking operation
adnan-ashraf May 2, 2024
727c57a
Provide functions enabling non-blocking operation in single measureme…
adnan-ashraf May 20, 2024
9c79d86
Merge branch 'master' into non-blocking-functions
Letme Aug 5, 2024
7316ce0
Arrange variables in reverse Christmas tree
adnan-ashraf Aug 6, 2024
0f78ee1
Write unit tests for functions enabling non-blocking operation
adnan-ashraf Aug 8, 2024
48fac6a
Fix tests
adnan-ashraf Aug 8, 2024
f7e7898
Improve tests
adnan-ashraf Aug 8, 2024
4d930cc
Run uncrustify
adnan-ashraf Aug 9, 2024
585109e
Update stylechecker to use latest version of uncrustify
adnan-ashraf Aug 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 117 additions & 2 deletions inc/mlx90632.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,8 @@ typedef enum mlx90632_meas_e {
/* Start of burst measurement options */
#define MLX90632_START_BURST_MEAS MLX90632_CFG_SOB(1)
#define MLX90632_BURST_MEAS_NOT_PENDING MLX90632_CFG_SOB(0)
/* Start of single measurement option */
#define MLX90632_START_SINGLE_MEAS (1 << MLX90632_CFG_SOC_SHIFT)

/* Device status register - volatile */
#define MLX90632_REG_STATUS 0x3fff /**< Device status register */
Expand Down Expand Up @@ -210,6 +212,47 @@ typedef enum mlx90632_meas_e {
#define MLX90632_NEW_REG_VALUE(old_reg, new_value, h, l) \
((old_reg & (0xFFFF ^ GENMASK(h, l))) | (new_value << MLX90632_EE_REFRESH_RATE_SHIFT))

/** Read raw ambient and object temperature only when measurement data is ready
*
* Read raw ambient and object temperatures without waiting. This values still need
* to be pre-processed via @link mlx90632_preprocess_temp_ambient @endlink and @link
* mlx90632_preprocess_temp_object @endlink functions and then processed via @link
* mlx90632_calc_temp_ambient @endlink and @link mlx90632_calc_temp_object @endlink
* to retrieve values in milliCelsius. This function assumes that measurement cycle
* has been triggered and completed via @link mlx90632_start_measurement @endlink or
* @link mlx90632_trigger_measurement @endlink or @link mlx90632_wait_for_measurement @endlink,
* and channel position has been checked via @link mlx90632_get_channel_position @endlink
* in case of continuous mode. This function assumes that measurement cycle has been
* triggered and completed via @link mlx90632_start_measurement_burst @endlink, or @link
* mlx90632_trigger_measurement_burst @endlink and @link mlx90632_wait_for_measurement_burst
* @endlink with sufficient time in between needed to refresh the whole measurement table
* in case of burst mode. This function assumes that measurement cycle has been
* triggered and completed via @link mlx90632_trigger_measurement_single @endlink and
* @link mlx90632_wait_for_measurement @endlink with sufficient time in between needed to
* refresh a single measurement in case of single mode (must be triggered and completed
* two times after power-up before calling this function).
*
* @param[in] channel_position Channel position where new (recently updated) measurement can be found,
* usually return value of @link mlx90632_start_measurement @endlink or
* @link mlx90632_wait_for_measurement @endlink or @link
* mlx90632_get_channel_position @endlink in case of continuous mode,
* 2 in case of burst mode, and return value of @link
* mlx90632_wait_for_measurement @endlink or @link
* mlx90632_get_channel_position @endlink in case of single mode
* @param[out] ambient_new_raw Pointer to where new raw ambient temperature is written
* @param[out] object_new_raw Pointer to where new raw object temperature is written
* @param[out] ambient_old_raw Pointer to where old raw ambient temperature is written
* @param[out] object_old_raw Pointer to where old raw object temperature is written
*
* @retval 0 Successfully read both temperatures
* @retval <0 Something went wrong. Check errno.h for more details
*
* @note This function is not blocking!
*/
int32_t mlx90632_read_temp_raw_wo_wait(int32_t channel_position,
int16_t *ambient_new_raw, int16_t *ambient_old_raw,
int16_t *object_new_raw, int16_t *object_old_raw);

/** Read raw ambient and object temperature
*
* Trigger and read raw ambient and object temperatures. This values still need
Expand Down Expand Up @@ -368,6 +411,30 @@ double mlx90632_calc_temp_object_reflected(int32_t object, int32_t ambient, doub
*/
int32_t mlx90632_init(void);

/** Trigger measurement for mlx90632
*
* Trigger measurement cycle. It does not read anything, just triggers measurement.
*
* @retval <0 Something failed. Check errno.h for more information
* @retval 0 Successfully triggered and started measuremeent
*
* @note This function is not blocking!
*/
int32_t mlx90632_trigger_measurement(void);

/** Wait for measurement to complete for mlx90632
*
* Wait for measurement data to be ready. It does not read anything, just completes measurement.
* This function assumes that measurement cycle has been triggered via @link
* mlx90632_trigger_measurement @endlink or @link mlx90632_trigger_measurement_single @endlink.
*
* @retval <0 Something failed. Check errno.h for more information
* @retval >=0 Channel position where new (recently updated) measurement can be found
*
* @note This function is using usleep so it is blocking!
*/
int32_t mlx90632_wait_for_measurement(void);

/** Trigger start measurement for mlx90632
*
* Trigger measurement cycle and wait for data to be ready. It does not read anything, just triggers and completes.
Expand All @@ -377,7 +444,7 @@ int32_t mlx90632_init(void);
*
* @note This function is using usleep so it is blocking!
*/
int mlx90632_start_measurement(void);
int32_t mlx90632_start_measurement(void);

/** Set emissivity which is retained in single variable.
*
Expand All @@ -391,6 +458,33 @@ void mlx90632_set_emissivity(double value);
*/
double mlx90632_get_emissivity(void);

/** Trigger burst measurement for mlx90632
*
* Trigger a full measurement cycle. It does not read anything, just triggers measurement.
* The SOB bit is set so that the complete measurement table is re-freshed.
*
* @note The SOB bit is cleared internally by the mlx90632 immediately after the measurement has started.
*
* @retval <0 Something failed. Check errno.h for more information
* @retval 0 Successfully triggered and started measuremeent
*
* @note This function is not blocking!
*/
int32_t mlx90632_trigger_measurement_burst(void);

/** Wait for burst measurement to complete for mlx90632
*
* Wait for measurement data to be ready. It does not read anything, just completes measurement.
* This function assumes that burst measurement cycle has been triggered via @link
* mlx90632_trigger_measurement_burst @endlink.
*
* @retval <0 Something failed. Check errno.h for more information
* @retval 0 New data is available and waiting to be processed
*
* @note This function is using usleep so it is blocking!
*/
int32_t mlx90632_wait_for_measurement_burst(void);

/** Trigger start of burst measurement for mlx90632
*
* Trigger a single measurement cycle and wait for data to be ready. It does not read anything, just triggers and completes.
Expand All @@ -407,6 +501,20 @@ double mlx90632_get_emissivity(void);
*/
int32_t mlx90632_start_measurement_burst(void);

/** Trigger single measurement for mlx90632
*
* Trigger a single measurement cycle. It does not read anything, just triggers measurement.
* The SOC bit is set so that the single measurement is triggered.
*
* @note The SOC bit is cleared internally by the mlx90632 immediately after the measurement has started.
*
* @retval <0 Something failed. Check errno.h for more information
* @retval 0 Successfully triggered and started measuremeent
*
* @note This function is not blocking!
*/
int32_t mlx90632_trigger_measurement_single(void);

/** Reads the refresh rate and calculates the time needed for a single measurment from the EEPROM settings.
*
* @param[in] meas Measurement to read the frefresh rate for
Expand Down Expand Up @@ -453,11 +561,18 @@ int32_t mlx90632_set_refresh_rate(mlx90632_meas_t measRate);
*/
mlx90632_meas_t mlx90632_get_refresh_rate(void);

/** Gets the channel position where new (recently updated) measurement can be found
*
* @retval <0 Something failed. Check errno.h for more information
* @retval >=0 Channel position where new (recently updated) measurement can be found
*/
int32_t mlx90632_get_channel_position(void);

///@}

#ifdef TEST
int32_t mlx90632_read_temp_ambient_raw(int16_t *ambient_new_raw, int16_t *ambient_old_raw);
int32_t mlx90632_read_temp_object_raw(int32_t start_measurement_ret,
int32_t mlx90632_read_temp_object_raw(int32_t channel_position,
int16_t *object_new_raw, int16_t *object_old_raw);

#endif
Expand Down
33 changes: 31 additions & 2 deletions inc/mlx90632_extended_meas.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,37 @@
#ifndef _MLX90632_EXTENDED_MEAS_LIB_
#define _MLX90632_EXTENDED_MEAS_LIB_

/** Read raw ambient and object temperature for extended range only when measurement data is ready
*
* Read raw ambient and object temperatures without waiting. This values still need
* to be pre-processed via @link mlx90632_preprocess_temp_ambient_extended @endlink and @link
* mlx90632_preprocess_temp_object_extended @endlink functions and then processed via @link
* mlx90632_calc_temp_ambient_extended @endlink and @link mlx90632_calc_temp_object_extended @endlink
* to retrieve values in milliCelsius. This function assumes that measurement cycle
* has been triggered and completed via @link mlx90632_start_measurement @endlink or
* @link mlx90632_trigger_measurement @endlink or @link mlx90632_wait_for_measurement @endlink,
* and channel position has been checked via @link mlx90632_get_channel_position @endlink
* in case of continuous mode. This function assumes that measurement cycle has been
* triggered and completed via @link mlx90632_start_measurement_burst @endlink, or @link
* mlx90632_trigger_measurement_burst @endlink and @link mlx90632_wait_for_measurement_burst
* @endlink with sufficient time in between needed to refresh the whole measurement table
* in case of burst mode. This function assumes that measurement cycle has been
* triggered and completed via @link mlx90632_trigger_measurement_single @endlink and
* @link mlx90632_wait_for_measurement @endlink with sufficient time in between needed to
* refresh a single measurement in case of single mode (must be triggered and completed
* three times after power-up before calling this function).
*
* @param[out] ambient_new_raw Pointer to where new raw ambient temperature is written
* @param[out] object_new_raw Pointer to where new raw object temperature is written
* @param[out] ambient_old_raw Pointer to where old raw ambient temperature is written
*
* @retval 0 Successfully read both temperatures
* @retval <0 Something went wrong. Check errno.h for more details
*
* @note This function is not blocking!
*/
int32_t mlx90632_read_temp_raw_extended_wo_wait(int16_t *ambient_new_raw, int16_t *ambient_old_raw, int16_t *object_new_raw);

/** Read raw ambient and object temperature for extended range
*
* Trigger and read raw ambient and object temperatures. This values still need
Expand All @@ -35,7 +66,6 @@
* @param[out] ambient_new_raw Pointer to where new raw ambient temperature is written
* @param[out] object_new_raw Pointer to where new raw object temperature is written
* @param[out] ambient_old_raw Pointer to where old raw ambient temperature is written
* @param[out] object_old_raw Pointer to where old raw object temperature is written
*
* @retval 0 Successfully read both temperatures
* @retval <0 Something went wrong. Check errno.h for more details
Expand All @@ -53,7 +83,6 @@ int32_t mlx90632_read_temp_raw_extended(int16_t *ambient_new_raw, int16_t *ambie
* @param[out] ambient_new_raw Pointer to where new raw ambient temperature is written
* @param[out] object_new_raw Pointer to where new raw object temperature is written
* @param[out] ambient_old_raw Pointer to where old raw ambient temperature is written
* @param[out] object_old_raw Pointer to where old raw object temperature is written
*
* @retval 0 Successfully read both temperatures
* @retval <0 Something went wrong. Check errno.h for more details
Expand Down
Loading