mainpage.h

Go to the documentation of this file.

/*
 * \file mainpage.h
 *
 * \brief Main Doxygen starting documentation page
 *
 * \copyright  J Factor Embedded Technologies LLC. 2021
 * \copyright  TJM Embedded Software LLC. 2021
 * \author  T. J. Mulrooney
 *
 */
 
#ifndef MAINPAGE_H_
#define MAINPAGE_H_
 
/*! \mainpage temp/Humidity BLE Sensor prototype System
 *
 * \image html ./images/J-FactorLogo.jpg
 *
 * This is prototype system for JFET Data Logger BLEProject.\n
 *
 * \copyright  J Factor Embedded Technologies LLC. 2023
 * \copyright  TJM Embedded Software LLC. 2023
 * \author  T. J. Mulrooney
 *
 * \todo
 * usb_enable deprecated \n
 * temp/humidity alarms \n
 * doxygen comments \n
 *
 * \version version history
 * \version     Version --- Date --- Author --- Comments
 * \version V 0.01 --- 11/11/23 ---TJM --- initial draft from  BLE UART Peripheral code\n
 * I2C working and connected to HDC2080\n
 * HDC2080 initialized and sending temp/humidity data auto conversion mode\n
 * semaphore used to wake up nRF52 when HDC2080 RDY pin goes active\n
 * app.overlay file added to include I2C and GPIO information\n
 * BLE advertising name includes unique device ID\n
 * \version V 0.02 --- 01/30/24 ---TJM --- added device ID to BLE string\n
 * new nrf52DK 52832 board\n added SPI code (BUF_SIZE = 128)\n added CLI\n
 * \version V 0.03 --- 09/29/25 ---TJM --- preparing for new "hockey puck" board\n
 * added simulated HDC2080 interrupt fo testing\n Flash parameters wroking\n
 * \version V 0.04 --- 10/20/25 ---TJM --- added SW2 (GPIO20) input Interrupt handler\n
 * added bleIndex to indicate BLE packet number sent \n
 * BLE saved packets are sent when connection is made \n
 * WDT timer working \n SW2 push starts advertising not done automatically on start\n
 * "#define SW2STARTSADVERTISING 1" added to control when advertising starts\n
 * \version V 0.05 --- 11/07/25 ---TJM --- added CLI duty cycle command\n
 * \version V 0.06 --- 11/11/25 ---TJM --- added received commands from nRF9160 handled same as normal CLI command\n
 * \version V 0.07 --- 11/14/25 ---TJM --- changed format of some help message\n
 * \version V 0.08 --- 11/17/25 ---TJM --- added BME68x.c and BME688 header files\n
 * added BME688 init and forced read code\n added BME688 CLI command to read BME688 data\n
 * added details to CLI dutycycle command\n
 * \version V 0.09 --- 12/22/25 ---TJM --- SK and toolchaim V3.2.1\n
 * \version V 0.10 --- 05/02/26 ---TJM --- myPrintfX to myPrintkX, added (nrf52832) to board message\n
 * added CONFIG_REBOOT to prj.conf\n
 * \version V 0.10 --- 05/02/26 ---TJM --- myPrintfX to myPrintkX, added (nrf52832) to board message\n
 * \version V 0.11 --- 05/06/26 ---TJM --- added battery BLE string\n
 * \version V 0.12 --- 05/27/26 ---TJM --- added semaphore to wait for CLI commands
 * added sensor ID, sensor name, locaion, customer, and group to flashparameters\n
 * \version V 0.13 --- 06/06/26 ---TJM --- added version field to device info \n
 * added flag to indicate when sending device info instead of sensor data in BLE packet\n
 * added datetime command to get time from gateway to be added to every string\n
 * \version V 0.14 --- 06/17/26 ---TJM --- added CLI "manualtrigger" command to read and sned HDC2080 temp/humidty on date time command. HDC
 * interrupts disabled \n if manaual trigger will send all data every new datetime ciommand \n
 * default manualtrigger = true on clear flash parameters \n
 * send board version (brdV, hardware version (hwV), and chip version (chV) \n
 * use CLI flashparameter manual trigger set HDC rate to manual \n
 * \version V 0.15 --- 07/08/26 ---TJM --- replaced in-line HDC interrupt handler with function call \n
 * flash parameter "ignorebme688" added to not use BME688 anywhere for lower power consumption \n
 * uncomment #define NO_UART0 in main.c to not use UART0 for lower power consumption (deprecated)\n
 * added flash parameter "nouart0" to SUSPEND UART0 (no CLI commands available) for lower power consumption note: once set can obly be
 * cleared by BLE command from gateway. \n if CONFIG_SERIAL=n in prj.conf then UART0 is not used and no CLI commands are available  lowest
 * power mode \n
 */
#endif /* MAINPAGE_H_ */