Skip to content

Commit

Permalink
Updated with the Sensor Module., M5Core2 sync with installed base
Browse files Browse the repository at this point in the history
  • Loading branch information
@konacurrents
konacurrents committed Feb 27, 2024
1 parent 964b3d8 commit ffb128e
Show file tree
Hide file tree
Showing 47 changed files with 3,835 additions and 712 deletions.
182 changes: 136 additions & 46 deletions Defines.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,53 @@
#ifndef Defines_h
#define Defines_h

//turn on or off which configuration is desired..
//! *** 6 main builds numbered below ****
//! 1. M5 Smart Clicker,
//! 2. ESP32 Feeder(orig),
//! 3. ESP32Feeder Board,
//! 4. M5 Atom,
//! 5. M5 Camera,
//! 6. M5Core2
//! ******** 1.22.24 ***********************

//turn on or off which configuration is desired..
//BOARD = M5Stick-C-Plus, type : make uploadFlashM5TEST
// *** 1
//#define ESP_M5_SMART_CLICKER_CONFIGURATION

//original feeder: (and any without PetTutor board. Otherwise Blue light doesn't flash)
//BOARD = ESP32 Dev Modulef type: make uploadFlashOrigTEST
// *** 2
//#define ESP_32_FEEDER

//When testing the new board, define _WITH_BOARD -- make uploadFlashBoardTEST
// *** 3
//#define ESP_32_FEEDER_WITH_BOARD

//original feeder: (or any) that also pairs with a GEN3 only, and gateways messages.
// *** 3b
//#define ESP_32_FEEDER_BLE_GEN3

//turn on or off which configuration is desired..
//turn on or off which configuration is desired..
// 12.26.23 added for the power socket ATOM
//BOARD = M5Stick-C-Plus, type : make uploadFlashM5AtomLiteTEST
#define ESP_M5_ATOM_LITE
// *** 4
//#define ESP_M5_ATOM_LITE


// an ESP M5 with a camera 8.11.22 (same as M5 without a display or buttons, but with a camera)
// Use the M5Stack-Timer-CAM library
// Use the Minimal SPIFF (1.9MB app, with OTA 190KB SPIFF), uses 57% so far (now: 61%)
// *** 5
//#define ESP_M5_CAMERA

//! 1.6.24 M5Core2Module
//! library M5Core2
//! minimal SPIFFS (1.9MB APP, with OTA/190KB SPIFFS)
//! https://docs.m5stack.com/en/api/core2/lcd_api
// *** 6
//#define M5CORE2_MODULE

//TRY this for close to minimal BLEClient (no WIFI, no BLEServerr)
//#define ESP_M5_SMART_CLICKER_CONFIGURATION_MINIMAL

Expand All @@ -41,12 +63,12 @@


//!global to all releases (for now) used in Status for M5 (only 2 characters)
#define VERSION_SHORT "v7"
#define VERSION_SHORT "v6"

//!used to force using the BLE Device name in SERVER( eg. PTFEEDER:ScoobyDoo)
//NOT NOW 9.14.22 (no)
//NOW: make default for v12.a on... 9.20.22
//OFF again on 1.6.23 - managed by preference:
//OFF again on 1.6.23 - managed by preference:
//#define FORCE_USE_BLE_SERVER_DEVICE_NAME

//! 9.29.22 support wildcard naming via TokenParser.h
Expand All @@ -61,25 +83,43 @@


// *** Start of Configurations ***
#define M5STACK_VERSION "2.0.4"
#define M5STACK_VERSION "2.0.4"
#define DHAT not working.. with 2.1.0
//#define M5STACK_VERSION "2.0.7" //9.24.23 (didn't seem to have heap space to start BLE server)
// 2.1 is too BIG .. 2.22.24 (ALSO: issue OTA of too big an app...)
//#define M5STACK_VERSION "2.1.0"

/* *************************** CONFIGURATIONS **********************************/

//M5stack 2.0.5-1.0 (Nov 2022)s
//! ****** MAIN: M5 ****
//M5stack 2.0.5-1.0 (Nov 2022)hula2127
//This is an easy way to turn on the smart clicker configuration...
#ifdef ESP_M5_SMART_CLICKER_CONFIGURATION
#define VERSION "Version-(2.17b)-11.29.2023-ESP_M5_SMART_CLICKER_BLE_GROUPS_SM_RAND"
//#define VERSION "Version-(2.17b)-11.29.2023-ESP_M5_SMART_CLICKER_BLE_GROUPS_SM_RAND"
//! 2.5.24 (scotty birthday)
#define VERSION "Version-(3.5b)-2.23.24-ESP_M5_SMART_CLICKER_KEY_SONIC_CLASS_30K"
//#define VERSION "Version-(3.6a)-2.22.24-BOOTSTRAP"

#define ESP_M5
#define USE_MQTT_NETWORKING
#define USE_BUTTON_MODULE
#define USE_WIFI_AP_MODULE
#define USE_BLE_CLIENT_NETWORKING
#define USE_BLE_SERVER_NETWORKING
#define USE_DISPLAY_MODULE
#define M5BUTTON_MODULE

//#define USE_SPIFF_MODULE
//#define USE_AUDIO_MODULE
//TODO: #define USE_FAST_LED

//! Sensors: 2.8.24 (30K above pacific)
#define KEY_UNIT_SENSOR_CLASS
#define USE_LED_BREATH

//! Ultrasonic-I2C
//! 2.23.24 after nice ski day, Da King beautiful weather (Laura along)
//! NOTE: won't work at same time as KEY_UNIT (overlapping). So how to fix that?
//#define ULTRASONIC_I2C_SENSOR_CLASS //NOTE: this is taking time away from M5 button presses...

//The M5_CAPTURE_SCREEN is an attempt to get the image of the M5. not working yet.. 8.25.22
// This issue is the backing store of the bitmap isn't there, so grabbing the pixels are blank
Expand All @@ -90,7 +130,9 @@
//! This is an ESP_M5 camera (such as the M5 Timer X. 8.11.22
//! Select M5Stack-Timer-CAM, Minimal SPIFFS (1.9mB APP with OTA/190KB Spiffs) 240MH WiFi/BT
#ifdef ESP_M5_CAMERA
#define VERSION "Version-(2.13)-11.21.2022-ESP_M5_CAMERA_WEBPAGE_Timer"
//#define VERSION "Version-(2.13)-11.21.2022-ESP_M5_CAMERA_WEBPAGE_Timer"
#define VERSION "Version-(2.2e)-1.20.2024-ESP_M5_CAMERA_WEBPAGE_Timer_Groups_HTTPS_RTSP"
//! still getting xQueueGenericSend error on "status" and "feed" message
#define ESP_M5
#define USE_MQTT_NETWORKING
#define USE_WIFI_AP_MODULE
Expand All @@ -105,7 +147,10 @@
#ifdef ESP_M5_SMART_CLICKER_CONFIGURATION_MINIMAL
#define VERSION "Version-(v1.3)-5.9.2022-ESP_M5_SMART_CLICKER-minimal"
#define ESP_M5
#define USE_BUTTON_MODULE
#define USE_BUTTON_MODULE // for generic button processing (with a display)
//! 1.22.24 added M5ButtonModule by itself..
#define M5BUTTON_MODULE

#define USE_BLE_CLIENT_NETWORKING
#define USE_DISPLAY_MODULE
#endif //ESP_M5_SMART_CLICKER_CONFIGURATION_MINIMAL
Expand All @@ -122,15 +167,15 @@
#define VERSION "Version-(2.15b)-7.16.2023-ESP_32_FEEDER_GROUPS2"
#else
//!normal BOARD - or the main feeders !! MODIFY THIS ONE...
#define VERSION "Version-(2.17a)-11.17.2023-ESP_32_FEEDER_GROUPS2_WIFI_AP"
#define VERSION "Version-(2.10)-2.17.2024-ESP_32_FEEDER_GROUPS3_WIFI_AP_NOSPACES"
#endif

#else // orig
#ifdef ESP_32_FEEDER_BLE_GEN3
#define VERSION "Version-(v2.12g)-10.23.2022-ESP_32_FEEDER-BLE_GEN3"
#else
//THIS IS WHERE VERSION FOR ORIGINAL ESP feeder (without board) 12.31.22
#define VERSION "Version-(2.16v)-10.13.2023-ESP_32_FEEDER_GROUPS2_WIFI_AP"
//THIS IS WHERE VERSION FOR ORIGINAL ESP feeder (without board) 12.31.22
#define VERSION "Version-(2.10)-2.17.2024-ESP_32_FEEDER_GROUPS3_WIFI_AP_NOSPACES"


#endif
Expand Down Expand Up @@ -186,9 +231,10 @@
//! library: not using M5Stack-ATOM (actually using M5Stack-C-Plus)
//! 12.26.23 day after xmas
//! https://docs.m5stack.com/en/atom/atom_socket
//! ALSO: use the Minimal SPIFF .. to make this 64% of program space (vs 99%)
//! ALSO: use the Minimal SPIFF
//! 2.25.23 Sketch uses 1497093 bytes (76%) of program storage space. Maximum is 1966080 bytes.
#ifdef ESP_M5_ATOM_LITE
#define VERSION "Version-(3.0)-1.5.24-ESP_M5_ATOM_QR_SCAN_SOCKET_SMART"
#define VERSION "Version-(3.5b)-2.5.24-ESP_M5_ATOM_QR_SCAN_SOCKET_SMART_GROUP_CLASS"
#define ESP_M5
#define M5_ATOM
#define USE_MQTT_NETWORKING
Expand All @@ -203,18 +249,50 @@
//! including ATOM_SOCKET_MODULE now ...
#define ATOM_SOCKET_MODULE

//! the ATOM uses FAST_LED
#define USE_FAST_LED

//! Sensors: 2.8.24 (30K above pacific)
//#define KEY_UNIT_SENSOR_CLASS
//#define USE_LED_BREATH

//! 11.14.23 try "https" secure web call (to SemanticMarker.org/bot/...)
//! See https://GitHub.com/konacurrents/SemanticMarkerAPI for more info
#define USE_REST_MESSAGING

#endif //ESP_M5_ATOM_LITE

//! 1.22.24 M5CORE2 uses M5Core2 Library (not M5StackC-Plus)
#ifdef M5CORE2_MODULE
#define VERSION "Version-(4.2)-2.8.24-ESP_M5CORE2_OurM5Dsp_Touch_30KPacific_KeyUnit"
#define ESP_M5
#define USE_MQTT_NETWORKING
#define USE_BUTTON_MODULE ///... ATOMQButtons.cpp
#define USE_WIFI_AP_MODULE
#define USE_BLE_SERVER_NETWORKING
#define USE_BLE_CLIENT_NETWORKING //try to be a smart clicker too..
#define USE_DISPLAY_MODULE

#if !defined(ESP_M5) && !defined(ESP_32) && !defined(M5_ATOM)
Error either ESP_M5 or ESP_32 or M5_ATOM must be defined
//! 11.14.23 try "https" secure web call (to SemanticMarker.org/bot/...)
//! See https://GitHub.com/konacurrents/SemanticMarkerAPI for more info
#define USE_REST_MESSAGING

//! from the ATOM code .. look at getting this working.
//#define USE_FAST_LED

//! Sensors: 2.8.24 (30K above pacific)
#define KEY_UNIT_SENSOR_CLASS
#define USE_LED_BREATH

#endif //M5CORE2_MODULE



#if !defined(ESP_M5) && !defined(ESP_32) && !defined(M5_ATOM) && !defined(M5CORE2_MODULE)
Error either ESP_M5 or ESP_32 or M5_ATOM or M5CORE2_MODULE must be defined
#endif
#if defined(ESP_M5) && defined(ESP_32) && defined(M5_ATOM)
Error only one of ESP_M5 or ESP_32 or M5_ATOM must be defined
#if defined(ESP_M5) && defined(ESP_32) && defined(M5_ATOM) && defined(M5CORE2_MODULE)
Error only one of ESP_M5 or ESP_32 or M5_ATOM or M5CORE2_MODULE must be defined
#endif


Expand Down Expand Up @@ -261,7 +339,11 @@ Error only one of ESP_M5 or ESP_32 or M5_ATOM must be defined
//#define OLD_BLE_NO_ACK_APPROACH

#ifdef ESP_M5
#ifdef M5CORE2_MODULE
#include <M5Core2.h>
#else
#include <M5StickCPlus.h>
#endif //M5Core2
#else
#include <Arduino.h>
#endif
Expand All @@ -283,7 +365,7 @@ Error only one of ESP_M5 or ESP_32 or M5_ATOM must be defined
#include "src/BLEClientModule/BLEClientNetworking.h"
#endif
#ifdef USE_BUTTON_MODULE
#include "src/ButtonModule/ButtonModule.h"
#include "src/ButtonModule/ButtonProcessing.h"
#endif
#ifdef USE_STEPPER_MODULE
#include "src/StepperModule/StepperModule.h"
Expand All @@ -310,11 +392,16 @@ Error only one of ESP_M5 or ESP_32 or M5_ATOM must be defined
#include "src/ATOM_SocketModule/ATOM_SocketModule.h"
#endif

//! 12.27.23
//! this lets an ATOM to not use the FAST_LED
#define USE_FAST_LED
#ifdef USE_FAST_LED
//#include "src/ATOM_LED_Module/M5Display.h"

//! 1.6.24
#ifdef M5CORE2_MODULE
#include "src/M5Core2Module/M5Core2Module.h"
#endif


//! 1.22.24 refactored it out to just M5
#ifdef M5BUTTON_MODULE
#include "src/M5Module/M5ButtonModule.h"
#endif

//! try a call..
Expand All @@ -327,26 +414,29 @@ Error only one of ESP_M5 or ESP_32 or M5_ATOM must be defined
//! add the MainModule.h so the defines for preferences are known
#include "src/MainModule/MainModule.h"

//! 1.22.24 refactored ButtonModule always avaialble, and it calls plugin modules
// MAYBE NOT ... #include "src/ButtonModule/ButtonProcessing.h"

//! DisplayModule is always included (it has dummy stubs for non Display ESP's)
#include "src/DisplayModule/DisplayModule.h"

//! SPIFFModule is always included
#include "src/MainModule/SPIFFModule.h"
/*
Code naming conventions, some to help not have linker duplicate symbols. Note: some of these issues of duplicate symbols is we are "C" without any encapsulation like an Object Oriented language would provide.
Code naming conventions, some to help not have linker duplicate symbols. Note: some of these issues of duplicate symbols is we are "C" without any encapsulation like an Object Oriented language would provide.
1. functions (methods) start with lower case,
to help find the function, prefix or postfix with the module name
eg.
eg.
2. local variables start with lower case
3. global variables start with _ (eg. int _globalVariable)
//note to prevent linker clashes, common names (like _preferences) should be
augmented with the module prefix: eg. _preferencesMQTTNetworking;
4. constants should be all upper case (eg. #define BLINK 3)
5. No global variables in ".h" - and if needed, wrap that in a function() call
eg. getFeederType()
Modules (eg. UI_MODULE, WIFI_APModule ..)
Modules (eg. UI_MODULE, WIFI_APModule ..)
1. enclose in #ifdef (#ifdef UI_MODULE) and "defines.h" sets them for a build (and maybe not for M5)
2. Each "Module", hould have a single ".h" that gets included elsewhere.
eg. WIFI_APModule.h
Expand All @@ -358,23 +448,23 @@ Error only one of ESP_M5 or ESP_32 or M5_ATOM must be defined
preSetup_<module>()
// and some more complicated module specific calls.
Defines:
Defines:
wrap with the #ifndef -- which is the same as #pragma once , etc
Note: https://www.tweaking4all.com/forum/arduino/arduino-ide-change-the-color-of-the-error-messages/
/Applications/Arduino.app/Contents/Java/lib/theme
Note: https://www.tweaking4all.com/forum/arduino/arduino-ide-change-the-color-of-the-error-messages/
/Applications/Arduino.app/Contents/Java/lib/theme
# GUI - CONSOLE
console.font = Monospaced,plain,11
console.font.macosx = Monaco,plain,10
console.color = #000000
console.output.color = #eeeeee
console.error.color = #E34C00
# GUI - CONSOLE
console.font = Monospaced,plain,11
console.font.macosx = Monaco,plain,10
console.color = #000000
console.output.color = #eeeeee
console.error.color = #E34C00
#ifndef ButtonModule_h
#define ButtonModule_h
....
#endif //ButtonModule_h
*/
#ifndef ButtonModule_h
#define ButtonModule_h
....
#endif //ButtonModule_h
*/

#endif // Defines_h
#endif // Defines_h

0 comments on commit ffb128e

Please sign in to comment.