mui.h

Go to the documentation of this file.

#ifndef MUI_H
#define MUI_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
// definition of packet structures of the measured data
#include <llcp_minipix_messages.h>
#include <llcp.h>
 
#include <stdint.h>
#include <stdbool.h>
 
// gives user more control over protocol handshakes, namely:
// * user needs to call mui_getFrameData() after he receives the mui_processFrameMeasurementFinished_t() callback. Otherwise, this callback is not called and
// the handshake happens automatically.
// * user needs to call mui_sendAck() after receiving FrameData, FrameDataTerminator, Temperature, and Status callbacks.
#ifndef MUI_USER_HANDSHAKES
#define MUI_USER_HANDSHAKES 0
#endif
 
// user can pass the mui_sendString_t to facilitate sending of data
#ifndef MUI_SEND_STRING
#define MUI_SEND_STRING 0
#endif
 
// user can pass the mui_sendChar_t to facilitate sending of data
#ifndef MUI_SEND_CHAR
#define MUI_SEND_CHAR 0
#endif
 
/* automatically-defined configs //{ */
 
#if ((MUI_SEND_CHAR == 1) && (MUI_SEND_STRING == 1))
#warning "MUI is compiled with both MUI_SEND_CHAR = 1 and MUI_SEND_STRING = 1, will expect pointer to mui_sendString_t during runtime"
#elif ((MUI_SEND_CHAR == 0) && (MUI_SEND_STRING == 0))
#error "Cannot have both MUI_SEND_CHAR and MUI_SEND_STRING set to 0. At least one data handling function needs to be used! Please, read README at https://github.com/klaxalk/minipix_uart_interface/tree/master/software/mui for more details."
#elif ((MUI_SEND_CHAR == 1) && (MUI_SEND_STRING == 0))
#pragma message("MUI is being compiled with MUI_SEND_CHAR = 1, it will expect pointer to the mui_sendChar_t function during runtime")
#elif ((MUI_SEND_CHAR == 0) && (MUI_SEND_STRING == 1))
#pragma message("MUI is being compiled with MUI_SEND_STRING = 1, it will expect pointer to the mui_sendString_t function during runtime")
#endif
 
#if MUI_USER_HANDSHAKES == 1
#warning "MUI_USER_HANDSHAKES is 1, do not forget to call mui_sendAck() according to the README"
#endif
 
//}
 
// | ---------- function pointers to user's callbacks --------- |
 
typedef void (*mui_ledSetHW_t)(const bool);
 
typedef void (*mui_sendChar_t)(const uint8_t char_out);
 
typedef void (*mui_sendString_t)(const uint8_t *str_out, const uint16_t len);
 
typedef void (*mui_processFrameData_t)(const LLCP_FrameData_t *image_data);
 
typedef void (*mui_processFrameMeasurementFinished_t)(void);
 
typedef void (*mui_processFrameDataTerminator_t)(const LLCP_FrameDataTerminator_t *terminator);
 
typedef void (*mui_processStatus_t)(const LLCP_Status_t *status_data);
 
typedef void (*mui_processTemperature_t)(const LLCP_Temperature_t *temperature_data);
 
typedef void (*mui_processAck_t)(const LLCP_Ack_t *ack_data);
 
typedef void (*mui_processMinipixError_t)(const LLCP_MinipixError_t *error_data);
 
typedef void (*mui_sleepHW_t)(const uint16_t duration);
 
typedef struct
{
  mui_ledSetHW_t                        ledSetHW;
  mui_sendChar_t                        sendChar;
  mui_sendString_t                      sendString;
  mui_processFrameData_t                processFrameData;
  mui_processFrameDataTerminator_t      processFrameDataTerminator;
  mui_processStatus_t                   processStatus;
  mui_processTemperature_t              processTemperature;
  mui_processAck_t                      processAck;
  mui_processMinipixError_t             processMinipixError;
  mui_processFrameMeasurementFinished_t processFrameMeasurementFinished;
  mui_sleepHW_t                         sleepHW;
} MUI_FcnPrototypes_t;
 
typedef struct
{
  LLCP_Receiver_t     llcp_receiver;
  uint8_t             tx_buffer[LLCP_RX_TX_BUFFER_SIZE];
  bool                led_state;
  MUI_FcnPrototypes_t fcns;
} MUI_Handler_t;
 
// --------------------------------------------------------------
// |                           public                           |
// --------------------------------------------------------------
 
// | ---------------------- "constructor" --------------------- |
 
void mui_initialize(MUI_Handler_t *mui_handler);
 
// | -------------- interraction with the MiniPIX ------------- |
 
void mui_pwr(MUI_Handler_t *mui_handler, const bool state);
 
void mui_measureFrame(MUI_Handler_t *mui_handler, const uint16_t acquisition_time, const uint8_t mode);
 
void mui_getFrameData(MUI_Handler_t *mui_handler);
 
void mui_setThreshold(MUI_Handler_t *mui_handler, const uint16_t threshold_coarse, const uint16_t threshold_fine);
 
void mui_setConfigurationPreset(MUI_Handler_t *mui_handler, const uint8_t preset);
 
void mui_updatePixelMask(MUI_Handler_t *mui_handler, LLCP_UpdatePixelMaskReq_t *data);
 
void mui_getStatus(MUI_Handler_t *mui_handle);
 
void mui_getTemperature(MUI_Handler_t *mui_handle);
 
// | ------------- UART communication with MiniPIX ------------ |
 
void mui_receiveCharCallback(MUI_Handler_t *mui_handler, const uint8_t byte_in);
 
// | --------------- the main update() function --------------- |
 
void mui_update(MUI_Handler_t *mui_handler);
 
void mui_sendAck(MUI_Handler_t *mui_handler, const bool success);
 
// --------------------------------------------------------------
// |                           private                          |
// --------------------------------------------------------------
 
void mui_sendMessage(MUI_Handler_t* mui_handler, const uint8_t* message, const uint16_t len);
 
// | -------------------- LED signalization ------------------- |
 
void mui_ledSet(MUI_Handler_t *mui_handler, const bool new_state);
 
void mui_ledToggle(MUI_Handler_t *mui_handler);
 
#ifdef __cplusplus
}
#endif
 
#endif  // MUI_H