jfet_common.h

Go to the documentation of this file.

/*!
 * \file jfet_common.h
 *
 * \brief common struct, enum, externs, prototypes
 *
 * \copyright  J Factor Embedded Technologies LLC. 2023
 * \copyright  TJM Embedded Software LLC. 2023
 * \author  T. J. Mulrooney
 *
 */
/*
 * All Rights Reserved
 * UNPUBLISHED, LICENSED SOFTWARE.
 *
 * CONFIDENTIAL AND PROPRIETARY INFORMATION
 * WHICH IS THE PROPERTY OF J-Factor Embedded Technologies.
 *
 */
#ifndef JFET_COMMON_H_
#define JFET_COMMON_H_
 
#include "bme68x.h"
#include "jfet_files/HDC2080.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <zephyr/drivers/gpio.h>
#include <zephyr/drivers/spi.h>
 
#define VERSION_MAJOR 0
#define VERSION_MINOR 15
 
#define VERSION_DATE "BLE Sensor 07/20/26"
#define BOARD_NAME "BLE Sensor Prototype"
 
#define VERSION_DATE_EXT1 " (Bd 1.0 UART0)"
#define VERSION_DATE_EXT2 " (Bd 1.0 No UART0)"
#define VERSION_DATE_EXT3 " (Bd 1.0 NO SERIAL)"
#define BOARD_NAME_EXT " V1.0 (nRF52832)"
 
#define FALSE 0
#define TRUE 1
 
#define DEFAULT_DUTYCYCLE TEN_SECONDS
 
#define SPI_BUF_SIZE 128
#define SPI_SLAVE 0
#define SLOW_FREQ 150000
#define FAST_FREQ 16000000
 
#define DATA_LENGTH 20
 
#define STR(x) #x
#define EXPAND_AND_STR(x) STR(x)
 
#define LOWTEMPENABLE 0x01
#define LOWTEMPACTIVE 0x02
#define HIGHTEMPENABLE 0x04
#define HIGHTEMPACTIVE 0x08
#define LOWHUMIDITYENABLE 0x01
#define LOWHUMIDITYACTIVE 0x02
#define HIGHHUMIDITYENABLE 0x04
#define HIGHHUMIDITYACTIVE 0x08
 
/* uncomment to use SW2 to start BLE advertising */
// #define SW2STARTSADVERTISING 1
 
enum SENSORTYPE {
  SENSORTYPEHDC2080,
  SENSORTYPEW25Q64JV,
  SENSORTYPEBME688,
  SENSORTYPEUNKNOWN,
};
 
#define MAX_PARAMETERS 3
#define MAX_FLASH_BYTES 0x200
#define FLASHPARAMETERSTART 0
#define FLASHBLESTART (FLASHPARAMETERSTART + 0x10)
#define FLASHPARAMETERKEY 0X12345678
// #define MAX_NUMBER_BLE_PACKETS 2000
// #define MAX_NUMBER_BLE_PACKETS 10
#define MAX_NUMBER_BLE_PACKETS 10
 
/*!
 * \brief Flash parameters structure
 *
 */
/*!
 */
typedef struct {
  uint32_t key; //!< 0x12345678 valid key
                //  uint8_t tempUnitsCentigrade;                                     //!< 1=C, 0=F
                //  uint8_t dateSet;                                                 //!< 1 = date set, 0 = date not set
                //  int8_t timeZone;                                                 //!< time zone relative to GMT/UTC
                //  uint8_t alarmsEnabled;                                           //!< 1 = global alarms enabled, 0 = global alarms
                //  disabled uint8_t gpsEnable;                                               //!< 1 = enable GPS, 0 = disable GPS when
                //  connecting to cloud uint8_t gpsExternal;                                             //!< 1 = external GPS, 0 = internal
                //  GPS when connecting to cloud uint8_t sw2;                                                     //!< switch 2 setting
  uint8_t silent; //!< = 0 running messages on, = 1 running messages off
  uint32_t
      dutyCycle;    //!< interval in seconds to send Sensor data to the cloud
                    //  uint32_t rsrpCycle;                                              //!< interval in seconds to send RSRP data to the
                    //  cloud uint32_t gpsFixCheck;                                            //!< interval in seconds to get a new GPS fix
  char sensorID[7]; //!< last 6 bytes of MAC address
  char sensorName[40];     //!< sensor name
  char customer[40];       //!< cutome name for this sensor
  char location[40];       //!< location of this sensor
  char group[40];          //!< group for this sensor
                           //  char distributor[40];                                            //!< distributor for this sensor
                           //  char clientID[20];                                               //!< client ID this sensor
                           //  tempAlarmStruct tempAlarms[MAX_NUMBER_TEMPERATURE_SENSORS];      //!< temperature alarm structures
                           //  uint16_t tempAlarmValid;                                         //!< time for a temp alarm to be valid
                           //  uint16_t tempAlarmCheck;                                         //!< time to check for alarms in seconds
                           //  humidityAlarmStruct humidityAlarms[MAX_NUMBER_HUMIDITY_SENSORS]; //!< humidity alarm structures
                           //  uint16_t humidityAlarmValid;                                     //!< time for a humidity alarm to be valid
                           //  uint16_t humidityAlarmCheck;                                     //!< time to check for alarms in seconds
                           //       uint16_t nextSavedRead;  //!< page address for next read JSON packet
  uint16_t nextSavedRead;  //!< page address of next write JSON packet
  uint16_t nextSavedWrite; //!< page address of next write JSON packet
  uint16_t savedCount;     //!< number of saved JSON packets
  //  uint8_t lowPower;                                                //!< low power mode enabled
  uint8_t manualTrigger; //!< disable HDC2080 interrups and trigger/read when datetime BLE command seen
  uint8_t ignoreBME688;  //!< disable BME688 anywhere in the code for lower power consumption
                         //  char edrx_param[5];                                              //!< EDRX param
                         //  char ptw_param[5];                                               //!< EDRX PWT param
                         //  char psm_param_rat[9];                                           //!< PSM param
                         //  char psm_param_rptau[9];                                         //!< PSM Tau param
                         //  uint8_t modenPMEnable;                                           //!< 1 = enable MODE_nPM, 0 = disable MODE_nPM
                         //  int16_t offsetAM2315;                                            //!< AM2315 offset degrees C/1000
                         //  pressureAlarmStruct pressureAlarms[MAX_NUMBER_PRESSURE_SENSORS]; //!< humidity alarm structures
                         //  uint16_t pressureAlarmValid;                                     //!< time for a pressure alarm to be valid
                         //  uint16_t pressureAlarmCheck;                                     //!< time to check for alarms in seconds
                         //  powerAlarmStruct powerAlarms[MAX_NUMBER_POWER_SENSORS];          //!< Power alarm structures
                         //  uint16_t powerAlarmValid;                                        //!< time for a power alarm to be valid
                         //  uint16_t powerAlarmCheck;                                        //!< time to check for alarms in seconds
                         //  int16_t offsetAM2315Humidity;                                    //!< AM2315 offset %/1000
                         //  int16_t offsetMSPPressure;                                       //!< MSP Pressure offset %/1000
                         //  ezoecAlarmStruct ezoecAlarms[MAX_NUMBER_EZO_SENSORS];            //!< humidity alarm structures
                         //  uint16_t ezoecAlarmValid;                                        //!< time for a ezoec alarm to be valid
                         //  uint16_t ezoecAlarmCheck;                                        //!< time to check for alarms in seconds
                         //  int16_t offsetEZORTD;                                            //!< RTD offset degrees C/1000
                         //  uint8_t sw1;                                                     //!< switch 1 setting
                         //  uint8_t cipu1;                                                   //!< CI_PU1 setting
                         //  uint8_t en12v0;                                                  //!< EN12V0 setting
                         //  uint8_t en24v0;                                                  //!< EN24V0 setting
                         //  uint8_t en5v0;                                                   //!< EN5V0 setting
                         //  uint8_t tagoio;                                                  //!< TagoIO setting
  uint8_t nouart0;       //!< no UART0 setting
  //   char sysRebootReason[30];                                        //!< reason that firmware issued a sys_reboot
  //   uint8_t shortJSON;                                               //!< send short JSON packet
  //   uint8_t adcConnected;                                            //!< state of ADC connection
  //   uint8_t cipd1;                                                   //!< CI_PD1 setting
  //   uint8_t cires;                                                   //!< CI_RES setting
  //   uint8_t rs485xcvren;                                             //!< RS485XCVREN setting
 
} flashParametersStruct;
 
/* prototypes */
// void myPrintk(char *str);
int myPrintk(char *restrict fmt, ...);
// void myPrintkW(char *str);
int myPrintkW(char *restrict fmt, ...);
// void myPrintkI(char *str);
int myPrintkI(char *restrict fmt, ...);
// void myPrintkS(char *str);
int myPrintkS(char *restrict fmt, ...);
// void myPrintkE(char *str);
int myPrintkE(char *restrict fmt, ...);
int init_i2c();
void hdc2080_rdy_seen(const struct device *dev, struct gpio_callback *cb, uint32_t pins);
void sw2_seen(const struct device *dev, struct gpio_callback *cb, uint32_t pins);
uint8_t bleCommand(uint8_t *data);
int getCmd(uint8_t *line);
int initHDC2080(void);
int initW25Q64JV(void);
int initBME688(void);
void readNVFlashxID(uint8_t *flashId);
void readNVFlashxStatus(uint8_t *flashStatus);
void flashxErasePage(uint32_t address);
void flashxEraseBlock1(uint32_t address);
void flashxEraseBlock2(uint32_t address);
void flashxEraseSector(uint32_t address);
void flashxErase(void);
void flashxReadPage(uint32_t address, uint8_t *flashRead);
void flashxWritePage(uint32_t page, uint32_t address, uint8_t *data, uint16_t count);
void flashxFillPage(uint32_t address, uint16_t data);
void flashxClearParameters(void);
void setFlashxParameters(uint8_t display);
void displayFlashxParameters(void);
void rescan(void);
void executeCmd(char *line);
int8_t getCLICmd(char *line);
int adc_sample(void);
void getFlashparameters(void);
void int64_to_string(int64_t num, char *str);
 
/* used to force count samples */
int getBME688Data(int count, uint8_t quiet);
 
/* externals */
extern uint16_t manfID;
extern uint16_t deviceID;
extern const struct device *const i2c_dev;
extern const struct device *const uart0_dev;
extern float hdcTemp;
extern float hdcHumidity;
extern char *cmdLineParameter[];
extern uint8_t numParameters;
extern char devIDStr[];
extern int ret;
extern uint8_t buffer_tx[];
extern uint8_t buffer_rx[];
extern struct spi_buf tx_bufs[];
extern struct spi_buf rx_bufs[];
extern struct spi_config spi_cfg1;
extern struct spi_config spi_cfg2;
extern const struct spi_buf_set tx;
extern const struct spi_buf_set rx;
extern const struct spi_cs_control spi_cs1;
extern const struct spi_cs_control spi_cs2;
extern const struct gpio_dt_spec spics1n;
extern const struct gpio_dt_spec spics2n;
extern const struct device *const spi_dev;
extern uint32_t sensorTypePresentAll;
extern float adc_voltage[];
extern uint8_t flashReadIn[];
extern const struct gpio_dt_spec baten;
extern struct k_sem hdc_rdy_seen;
extern struct k_sem uart_rx_disabled_sem;
extern char resetCause[];
extern char myStr[];
extern flashParametersStruct flashParameters;
extern uint8_t tmpData[];
extern uint32_t bleIndex;
extern uint8_t stopWDTFeed;
extern uint8_t hdcMinutes;
extern struct bme68x_dev bme688_dev;
extern struct bme68x_data BME688Data;
extern char cliCMD[];
extern uint8_t sendingDeviceInfo;
extern long long gatewayDateTime;
extern char gatewayEpoch[];
 
#endif /* JFET_COMMON_H_ */