KeyUnitSensorClass.cpp

Go to the documentation of this file.

 
#include "KeyUnitSensorClass.h"
 
#include "../../defines.h"
#if defined(ESP_M5) && !defined(ESP_M5_MINIMAL_SENSORS)
 
//#include <iostream>
#include <string.h>
#include <stdio.h>
 
#ifdef ESP_M5
#ifdef M5CORE2_MODULE
//#include <M5Display.h>
#else
#ifdef M5STICKCPLUS2
#include <M5StickCPlus.h>
#endif
 
#endif
#endif
 
KeyUnitSensorClass::KeyUnitSensorClass(char *config)  : SensorClassType(config)
{
    
    printf("KeyUnitSensorClass init %s\n", config);
    _ledColor = 0;
#ifdef USE_FAST_LED
    _leds = new CRGB[1] ;       // Define the array of leds.  定义LED阵列.
#endif
}
 
KeyUnitSensorClass::~KeyUnitSensorClass()
{
   printf("KeyUnitSensorClass destroy\n");
}
 
 
#define USE_LED
#ifdef USE_LED
#ifdef USE_FAST_LED
//#include <FastLED.h>
#endif
 
//! 8.20.24
//! The PIN map stuff is tricky, and I don't know how to do this except via configuration messages
//! (or Compile defines).
//! When using the M5Atom, the PIN Port (next to the power is: G19, G21,G22,G23,G25, G33)
//! But if using the the PORT B or the IC-2, the pins are DATA_PIN 23, KEY_PIN 33
//! But the port out the back in DATA_PIN 26, KEY_PIN 32
//! HOW TO KNOW THIS ???   With the QRCode scanner, it's the port out the back
//! If the
//! @see https://shop.m5stack.com/products/mechanical-key-button-unit
//! 8.21.24 .. quick test, will use factoryClockwise to change these for a test
//! if factoryClockwise then it's plugged into the M5 (DATA_PIN 26, KEY_PIN 32)
//! if not factoryClockwise then it's the extension ..  (DATA_PIN 23, KEY_PIN 33)
 
#ifdef ATOM_QRCODE_MODULE
#ifdef ESP_M5_ATOM_S3
//! port b
#define DATA_PIN 35
//!@see https://github.com/FastLED/FastLED/blob/356a3794d9d2b027685a374715e32d0ee2ad3e9b/examples/SpecialDrivers/ESP/DriverTest/PlatformConfig.h#L37
//!@see https://github.com/esphome/issues/issues/4501
//!the RGB pin 35
#else
//! port b
#define DATA_PIN 26
#endif
int getDATA_PIN()
{
    int pin;
    //! 7.12.25
    pin = DATA_PIN;
   // SerialDebug.printf("getDATA_PIN = %d\n", pin);
    return pin;
}
#else
#define DATA_PIN 32  // Define LED pin.  定义LED引脚.
int getDATA_PIN() { return DATA_PIN; };
 
#endif
#endif
 
//#define USE_LED_BREATH  //not working, (working for M5button and Core2)
//! for ATOM (maybe change the priority and see what happens)
 
 
//!wrapper static method
void KeyUnitSensorClass::startTaskImpl(void* _this)
{
    SerialDebug.printf(" startTaskImpl == %p\n", _this);
    
#ifdef USE_LED_BREATH
     ((KeyUnitSensorClass*)_this)->keyUnitLED();
#endif
}
#define KEY_UNIT_GROVE
#ifdef  KEY_UNIT_GROVE
#ifdef ATOM_QRCODE_MODULE
//! port b
#ifdef ESP_M5_ATOM_S3
//! 7.12.26 lots of room
//! G32 -> G1
#define KEY_PIN 1
#else
#define KEY_PIN 32
#endif
int getKEY_PIN()
{
    int pin;
    //! 7.12.25
    pin = KEY_PIN;
   // SerialDebug.printf("getKEY_PIN = %d\n", pin);
    return pin;
 
 
}
#else
#define KEY_PIN 33 //Define Key Pin.  定义Key引脚
int getKEY_PIN() { return KEY_PIN; };
#endif //ATOM_QRCODE_MODULE
                   //!setup the KeyUnit
void KeyUnitSensorClass::setupKeyUnit()
{
    SerialDebug.printf("KeyUnitSensorClass.setupKeyUnit == %p\n", this);
    SerialDebug.printf("KeyUnitSensorClass. **** NOT pinMODE ... *******\n");
 
 //DEBUG  7.10.26 FIX???
    pinMode(getKEY_PIN(), INPUT_PULLUP);  // Init Key pin.  初始化Key引脚.
    
    //! 5.3.25 register our PIN use
    registerPinUse_mainModule(getKEY_PIN(), "KEY_PIN", "KeyUnitSensorClass", false);
    //26 -- fastLED .. registerPinUse_mainModule(getDATA_PIN(), "DATA_PIN", "KeyUnitSensorClass", false);
 
#ifdef USE_FAST_LED
 
#ifdef USE_LED
    getDATA_PIN();
    getKEY_PIN();
    if (getPreferenceBoolean_mainModule(PREFERENCE_STEPPER_FACTORY_CLOCKWISE_MOTOR_DIRECTION_SETTING))
    {
        FastLED.addLeds<SK6812, 26, GRB>(this->_leds, 1);  // Init FastLED.  初始化FastLED.
        //! 5.3.25 register our PIN use
        registerPinUse_mainModule(26, "FastLED", "KeyUnitSensorClass", false);
 
    }
    else
    {
        FastLED.addLeds<SK6812, 23, GRB>(this->_leds, 1);  // Init FastLED.  初始化FastLED.
        //! 5.3.25 register our PIN use
        registerPinUse_mainModule(23, "FastLED", "KeyUnitSensorClass", false);
    }
#endif
#endif
    
#ifdef USE_LED_BREATH_x  //not working,
    //!@see https://stackoverflow.com/questions/45831114/c-freertos-task-invalid-use-of-non-static-member-function
    //!@see https://www.freertos.org/FreeRTOS_Support_Forum_Archive/July_2010/freertos_Is_it_possible_create_freertos_task_in_c_3778071.html
    //!@see https://stackoverflow.com/questions/77931188/c-freertos-task-this-instance-being-passed-as-null?noredirect=1#comment137393059_77931188
    //!4th parameter cannot be NULL but instead is 'this'
    //!NOTE: 2024 stack size needed .. otherwise stack overflow 2.5.24 (my birthday)
    xTaskCreate(
                &this->startTaskImpl, "led", 2024, this, 0,
                NULL);  // Create a thread for breathing LED. 创建一个线程用于LED呼吸灯.
#endif
    
}
 
 
//! loop the key unit (after other called M5.updfate)
void KeyUnitSensorClass::loopKeyUnit()
{
#pragma mark DEBUG_bad_maybeGoodNOW
    //if (false)
    if (!digitalRead(getKEY_PIN()))
    {
        // If Key was pressed.  如果按键按下.
        SerialDebug.println("KeyUnitSensorClass.Key Pressed");
#ifdef USE_LED
        changeLedColor();  // Change LED color.  更换LED呼吸灯颜色.
#endif
        long startTime = micros();
 
        //! THERE should be a time limit on the button .. say 10 or so..
        while (!digitalRead(getKEY_PIN()))
            // Hold until the key released.  在松开按键前保持状态.
            ;
        long endTime = micros();
        double diffTime = endTime - startTime;
        //microseconds
        double seconds = diffTime / 1000000;
        SerialDebug.printf("KU.Key Released: %f\n", seconds);
 
        if (seconds > 2.0)
        {
            SerialDebug.printf("KU.Long Press: %f\n", seconds);
 
#define USE_OPTION_1
#ifdef USE_OPTION_1
            //! 11.26.25
            //! as per issue #412 option 1 is to store locally,
            togglePreferenceBoolean_mainModule(PREFERENCE_STEPPER_BUZZER_VALUE);
            //! 8.16.25 BLE CLIENT                //!optimized to not send the wrapper around the message
            // need to send B or b .. depending on result
            if (getPreferenceBoolean_mainModule(PREFERENCE_STEPPER_BUZZER_VALUE))
                sendCommandBLEClient_13orLess("B");
            else
                sendCommandBLEClient_13orLess("b");
#else
            //! call their  (on the other side of this BLE) toggle the buzzer...
            processClientCommandChar_mainModule('f');
#endif
        }
        else
        {
            //!call the callback
            callCallback((char*)"keyPressed",true);
        }
        
    }
}
 
 
 
#ifdef USE_LED_BREATH
void KeyUnitSensorClass::keyUnitLED() {
 
    SerialDebug.printf(" setupKeyUnit %p\n", this);
    //! default to RED
#ifdef USE_FAST_LED
 
    _leds[0] = CRGB::Red;
    for (;;) {
        for (int i = 0; i < 255; i++)
        {
            //! Set LED brightness from 0 to 255.  设置LED亮度从0到255.
            FastLED.setBrightness(i);
            FastLED.show();
            delay(5);
        }
        for (int i = 255; i > 0;  i--)
        {
            //! Set LED brightness from 255 to 0.  设置LED亮度从255到0.
            FastLED.setBrightness(i);
            FastLED.show();
            delay(5);
        }
    }
    vTaskDelete(NULL);
#endif
}
#endif
 
void KeyUnitSensorClass::changeLedColor() {
#ifdef USE_FAST_LED
    SerialDebug.println("changeLedColor");
    _ledColor++;
    if (_ledColor > 2) _ledColor = 0;
    switch (_ledColor)
    {  // Change LED colors between R,G,B.  在红绿蓝中切换LED颜色.
        case 0:
            _leds[0] = CRGB::Red;
            break;
        case 1:
            _leds[0] = CRGB::Green;
            break;
        case 2:
            _leds[0] = CRGB::Blue;
            break;
        default:
            break;
    }
#endif
}
#endif //key unit grove
 
 
 
//! error: https://stackoverflow.com/questions/3065154/undefined-reference-to-vtable
//!@see https://www.w3schools.com/cpp/cpp_class_methods.asp
void KeyUnitSensorClass::loop()
{
    //!setup the KeyUnit
    loopKeyUnit();
}
 
void KeyUnitSensorClass::setup()
{
    printf("KeyUnitSensorClass::setup()\n");
    
    setupKeyUnit();
}
 
#ifdef NOT_DEFINED
 
//! adding the messages as well
//! 5.14.25 (Laura/Paul flying). 5.14.74 great Dead
//! 8.28.23  Adding a way for others to get informed on messages that arrive
//! for the set,val
//! 12.27.23 support setName == "socket"
//! 1.10.24 if deviceNameSpecified then this matches this device, otherwise for all.
//! It's up to the receiver to decide if it has to be specified
void KeyUnitSensorClass::messageSetVal_SensorClassType(char *setName, char* valValue, boolean deviceNameSpecified)
{
    
}
 
//! 12.28.23, 8.28.23  Adding a way for others to get informed on messages that arrive
//! for the  send -
void KeyUnitSensorClass::messageSend_SensorClassType(char *sendValue)
{
    
}
 
//! 12.28.23, 8.28.23  Adding a way for others to get informed on messages that arrive
//! for the cmd
void KeyUnitSensorClass::messageCmd_SensorClassType(char *cmdValue)
{
    
}
 
 
//! 5.15.25 try a special command local to this class
void KeyUnitSensorClass::messageLocal_SensorClassType(char *message)
{
    
}
#endif
#endif //ESP_M5