IRPyro API
(sKEMLIB1)
Collection of routines and data structures covering the functionality of the IRPyro sensor
|
IRPyro Application interface functions implementation More...
#include "Version.h"
#include "IRPyro_API_single_device_layer.h"
#include "IRPyro_API_multi_device_layer.h"
Go to the source code of this file.
Functions | |
uint8_t | IRPyro_close_devices (IRPyro_devices this_list, uint8_t list_size) |
Stops streaming, deallocates memory and disable the IRPyro sensor. More... | |
uint8_t | IRPyro_ioctl_devices (IRPyro_devices this_list, uint8_t list_size, IRPyro_cmd_type *cmd, IRPyro_arg_type arg) |
access to IRPyro registers More... | |
uint8_t | IRPyro_open_devices (IRPyro_devices this_list, uint8_t list_size) |
initializes a group of IRPyro sensors More... | |
uint8_t | IRPyro_read_devices (IRPyro_devices this_list, uint8_t list_size) |
Collects data from the IRPyro group. More... | |
IRPyro Application interface functions implementation
=============================================================================== ##### How to use this driver ##### =============================================================================== [..] (#) Make sure that IRPyro_LIST_SIZE is big enough for your list (#) Declare an IRPyro_list_type variable in your code (#) Declare as many IRPyro_sensor_device_type variables as IRPyros sensors on the list. (#) Fill the values for CS, INT and address for each IRPyro (#) Fill the values for number_of_active_channels and read_mode (#) AFE, CCP and WUP can be left empty if desired, configuration macros will fill them with default values (#) Call IRPyro_open() to commit the values to the physical IRPyro (#) IRPyro_read() retrieves the values sampled by the IRPyro sensor (#) Modify the IRPyro settings using IRPyro_IOCTL() (#) Close the device when finished using IRPyro_read()
Copyright (c) 2018, _KEMET, Ltd All rights reserved. THIS SOFTWARE IS PROVIDED BY _KEMET, Ltd ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL _KEMET, Ltd BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Definition in file IRPyro_API_multi_device_layer.c.