Sean Wilson
/
AdiSense1000_V21
AdiSense1000_V21 MBED API
Fork of AdiSense1000 by
Diff: inc/adi_sense_1000/adi_sense_1000_api.h
- Revision:
- 28:4eb837cd71df
- Parent:
- 26:12d0204be712
diff -r 12d0204be712 -r 4eb837cd71df inc/adi_sense_1000/adi_sense_1000_api.h --- a/inc/adi_sense_1000/adi_sense_1000_api.h Mon Mar 26 14:50:05 2018 +0000 +++ b/inc/adi_sense_1000/adi_sense_1000_api.h Thu May 17 10:34:45 2018 +0100 @@ -1,8 +1,20 @@ -/*! - ****************************************************************************** - * @file: adi_sense_api.h - * @brief: ADSNS1000 Host Library Application Programming Interface (API) - *----------------------------------------------------------------------------- +/* +CONFIDENTIAL AND PROPRIETARY INFORMATION + +Copyright (c) 2018 Emutex Ltd. All rights reserved. +This software and documentation contain confidential and +proprietary information that is the property of +Emutex Ltd. The software and documentation are +furnished under a license agreement and may be used +or copied only in accordance with the terms of the license +agreement. No part of the software and documentation +may be reproduced, transmitted, or translated, in any +form or by any means, electronic, mechanical, manual, +optical, or otherwise, without prior written permission +of Emutex Ltd., or as expressly provided by the license agreement. +Reverse engineering is prohibited, and reproduction, +disclosure or use without specific written authorization +of Emutex Ltd. is strictly forbidden. */ /* @@ -40,6 +52,13 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/*! + ****************************************************************************** + * @file: adi_sense_api.h + * @brief: ADSNS1000 Host Library Application Programming Interface (API) + *----------------------------------------------------------------------------- + */ + #ifndef __ADI_SENSE_1000_API_H__ #define __ADI_SENSE_1000_API_H__ @@ -210,6 +229,27 @@ uint32_t nMeasurementsPerCycle); /*! + * @brief Update priority level for a specific channel. + * + * @param[in] hDevice ADI Sense device context handle + * @param[in] eChannelId Selects the channel to be updated + * @param[in] ePriority Specifies the channel priority level + * + * @return Status + * - #ADI_SENSE_SUCCESS Call completed successfully. + * + * @details Translates configuration details provided into device-specific + * register settings and updates device configuration registers. + * Allows individual channels to be dynamically re-prioritised. + * + * @note Settings are not applied until adi_sense_ApplyConfigUpdates() is called + */ +ADI_SENSE_RESULT adi_sense_1000_SetChannelPriority( + ADI_SENSE_DEVICE_HANDLE hDevice, + ADI_SENSE_1000_CHANNEL_ID eChannelId, + ADI_SENSE_1000_CHANNEL_PRIORITY ePriority); + +/*! * @brief Update the measurement threshold limits for a specified channel. * * @param[in] hDevice ADISENSE device context handle @@ -240,6 +280,27 @@ float32_t fHighThresholdLimit, float32_t fLowThresholdLimit); + +/*! + * @brief Set a sensor specific parameter for a specified channel. + * + * @param[in] hDevice ADI Sense device context handle + * @param[in] eChannelId Selects the channel to be updated + * @param[in] fSensorParam Sensor specific parameter + * + * @return Status + * - #ADI_SENSE_SUCCESS Call completed successfully. + * + * @details Translates configuration details provided into device-specific + * register settings and updates device configuration registers. + * Allows optional sensor-specific parameter to be specified + * + * @note Settings are not applied until adi_sense_ApplyConfigUpdates() is called + */ +ADI_SENSE_RESULT adi_sense_1000_SetSensorParameter( + ADI_SENSE_DEVICE_HANDLE hDevice, + ADI_SENSE_1000_CHANNEL_ID eChannelId, + float32_t fSensorParam); /*! * @brief Update the extra settling time for a specified channel. * @@ -344,6 +405,7 @@ * available when DATAREADY is asserted * @param[out] pnSamplesPerCycle Pointer to return the calculated number of samples * produced per measurement cycle + * @param[out] pnBytesPerSample Pointer to return the size, in bytes, of each sample * * @return Status * - #ADI_SENSE_SUCCESS Call completed successfully. @@ -360,7 +422,8 @@ ADI_SENSE_1000_OPERATING_MODE * const peOperatingMode, ADI_SENSE_1000_DATAREADY_MODE * const peDataReadyMode, uint32_t * const pnSamplesPerDataready, - uint32_t * const pnSamplesPerCycle); + uint32_t * const pnSamplesPerCycle, + uint8_t * const pnBytesPerSample); #ifdef __cplusplus } @@ -371,4 +434,3 @@ */ #endif /* __ADI_SENSE_1000_API_H__ */ -