#include "../SensorClass/SensorClassType.h"
Go to the source code of this file.
Classes | |
| struct | sensorStruct |
| struct | sensorsStruct |
| wrap sensors More... | |
| struct | ChainButtonStruct |
| struct | ChainUseStruct |
Macros | |
| #define | STEPPER_IS_UNO 1 |
| #define | STEPPER_IS_MINI 2 |
| #define | STEPPER_IS_TUMBLER 3 |
| #define | PREFERENCE_MAIN_GATEWAY_VALUE 0 |
| #define | PREFERENCE_MAIN_BLE_SERVER_VALUE 1 |
| #define | PREFERENCE_MAIN_BLE_CLIENT_VALUE 2 |
| #define | PREFERENCE_STEPPER_BUZZER_VALUE 3 |
| stepper preferences More... | |
| #define | PREFERENCE_STEPPER_SINGLE_FEED_VALUE 4 |
| #define | PREFERENCE_STEPPER_AUTO_FEED_VALUE 5 |
| #define | PREFERENCE_STEPPER_JACKPOT_FEED_VALUE 6 |
| #define | PREFERENCE_STEPPER_ANGLE_FLOAT_SETTING 7 |
| #define | PREFERENCE_STEPPER_KIND_VALUE 8 |
| uses STEPPER type More... | |
| #define | PREFERENCE_STEPPER_FEEDS_PER_JACKPOT 9 |
| #define | PREFERENCE_SENSOR_TILT_VALUE 10 |
| Sensor preferences. More... | |
| #define | PREFERENCE_SENSOR_PIR_VALUE 11 |
| #define | PREFERENCE_SEMANTIC_MARKER_ZOOMED_VALUE 12 |
| Display preferences (SemanticMarker etc) - boolean. More... | |
| #define | PREFERENCE_DISPLAY_ON_BLANK_SCREEN_VALUE 13 |
| Display preferences - show messages on blank screen- boolean. More... | |
| #define | PREFERENCE_DISPLAY_SCREEN_TIMEOUT_VALUE 14 |
| sets the timeout value More... | |
| #define | PREFERENCE_HIGH_TEMP_POWEROFF_VALUE 15 |
| sets the max temp for a poweroff More... | |
| #define | PREFERENCE_IS_MINIMAL_MENU_SETTING 16 |
| sets the max temp for a poweroff More... | |
| #define | PREFERENCE_NO_BUTTON_CLICK_POWEROFF_SETTING 17 |
| #define | WIFI_CREDENTIALS_MAX 2 |
| for now, save 2 WIFI Credentials More... | |
| #define | PREFERENCE_WIFI_CREDENTIAL_1_SETTING 18 |
| #define | PREFERENCE_WIFI_CREDENTIAL_2_SETTING 19 |
| #define | PREFERENCE_PAIRED_DEVICE_SETTING 20 |
| the paired device for guest device feeding (6.6.22) More... | |
| #define | PREFERENCE_DEVICE_NAME_SETTING 21 |
| the device name itself (6.6.22) More... | |
| #define | PREFERENCE_FIRST_TIME_FEATURE_SETTING 22 |
| a firsttime feature flag (only 1 per build) 7.12.22 defaulting to TRUE More... | |
| #define | PREFERENCE_ONLY_GEN3_CONNECT_SETTING 23 |
| if true, only BLEClient connect to GEN3 feeders.. More... | |
| #define | PREFERENCE_SCREEN_COLOR_SETTING 24 |
| ithe color of the screen 0..n More... | |
| #define | PREFERENCE_BLE_SERVER_USE_DEVICE_NAME_SETTING 25 |
| if set, the BLE Server (like PTFeeder) will tack on the device name (or none if not defined). More... | |
| #define | PREFERENCE_BLE_USE_DISCOVERED_PAIRED_DEVICE_SETTING 26 |
| #define | PREFERENCE_USE_DOC_FOLLOW_SETTING 27 |
| for More... | |
| #define | PREFERENCE_SUB_DAWGPACK_SETTING 28 |
| 8.17.22 to turn on/off subscribing to the dawgpack topic More... | |
| #define | PREFERENCE_USE_SPIFF_SETTING 29 |
| 8.22.22 to turn on/off SPIFF use (more below..) More... | |
| #define | PREFERENCE_PAIRED_DEVICE_ADDRESS_SETTING 30 |
| the paired device for guest device feeding (6.6.22) .. but the Address 9.3.22 More... | |
| #define | PREFERENCE_STEPPER_FACTORY_CLOCKWISE_MOTOR_DIRECTION_SETTING 31 |
| #define | PREFERENCE_SENDWIFI_WITH_BLE 32 |
| sends the WIFI to all except current device if set More... | |
| #define | PREFERENCE_NOTIFY_BLE_DISCOVERY 33 |
| starts the BLE Discovery notification process - which might be internal or externa (via messages). More... | |
| #define | PREFERENCE_TIMER_INT_SETTING 34 |
| the preference timer More... | |
| #define | PREFERENCE_SUPPORT_GROUPS_SETTING 35 |
| the preference for supporting GROUPS (default true) More... | |
| #define | PREFERENCE_GROUP_NAMES_SETTING 36 |
| the preference setting group names to subscribe (but empty or # go to wildcard, this also supports wildcard in the future) More... | |
| #define | PREFERENCE_DEBUG_INFO_SETTING 37 |
| a place to put some kind of Last Will of what went wrong .. for now (> max tries) More... | |
| #define | PREFERENCE_DEV_ONLY_SM_SETTING 38 |
| adding AP_DEBUG_MODE to let others know that DEBUG eprom is available. Turn this OFF for non dev More... | |
| #define | PREFERENCE_TIMER_MAX_INT_SETTING 39 |
| the preference timer MAX (pairs with PREFERENCE_TIMER_INT_SETTING) More... | |
| #define | PREFERENCE_ATOMS_SETTING 40 |
| 1.1.24 the preference for all the ATOM plugs (format: atomType:value} .. for now just use socket:on More... | |
| #define | PREFERENCE_ATOM_KIND_SETTING 41 |
| 1.4.24 What kind of ATOM plug (set, M5AtomKind, val= {M5AtomSocket, M5AtomScanner} More... | |
| #define | PREFERENCE_SM_ON_PIR_SETTING 42 |
| 1.10.24 Flag on whether a Semantic Marker command is sent on PIR, and the Command to send More... | |
| #define | PREFERENCE_SM_COMMAND_PIR_SETTING 43 |
| 1.10.24 The Semantic Marker command is sent on PIR, and the Command to send More... | |
| #define | PREFERENCE_SM_COMMAND_PIR_OFF_SETTING 44 |
| 1.11.24 The Semantic Marker command is sent on PIR, and the Command to send on OFF (or opposite) More... | |
| #define | PREFERENCE_ATOM_SOCKET_GLOBAL_ONOFF_SETTING 45 |
| 1.12.24 Whether the AtomSocket accepts global on/off messages More... | |
| #define | PREFERENCE_USE_SPIFF_MQTT_SETTING 46 |
| #define | PREFERENCE_USE_SPIFF_QRATOM_SETTING 47 |
| For MQTT writing to the QRATOM. More... | |
| #define | PREFERENCE_STEPPER_AUTO_MOTOR_DIRECTION_SETTING 48 |
| #define | PREFERENCE_INCLUDE_GROUP_NAMES_SETTING 49 |
| 8.2.24 don't change subscription but include these groups (eg. safeHouse,atlasDogs) More... | |
| #define | PREFERENCE_STEPPER_CLOCKWISE_MOTOR_DIRECTION_SETTING 50 |
| #define | PREFERENCE_SENSOR_PLUGS_SETTING 51 |
| #define | PREFERENCE_SENSORS_SETTING 52 |
| #define | PREFERENCE_STEPPER_RPM_SETTING 53 |
| #define | PREFERENCE_STEPPER_2FEED_SETTING 54 |
| #define | PREFERENCE_CHAIN_SENSORS_SETTING 55 |
| #define | MAX_MAIN_PREFERENCES 56 |
| ******* 1 greater than last value **** IMPORTANT *** and no gaps.. More... | |
| #define | ATOM_KIND_M5_SCANNER 0 |
| returned from mainModule More... | |
| #define | ATOM_KIND_M5_SOCKET 1 |
| #define | NEW_SENSORS_PREFERENCE |
| #define | CHAIN_USE_MAX 20 |
| #define | BUTTON_ANY -1 |
| #define | BUTTON_SHORT_PRESS 0 |
| #define | BUTTON_LONG_PRESS 1 |
| #define | BUTTON_DOUBLE_PRESS 2 |
| #define | BUTTON_JOYSTICK_LEFT 100 |
| map x,y to quadrants More... | |
| #define | BUTTON_JOYSTICK_TOP 101 |
| #define | BUTTON_JOYSTICK_RIGHT 102 |
| #define | BUTTON_JOYSTICK_BOTTOM 103 |
Typedefs | |
| typedef struct sensorStruct | SensorStruct |
| typedef struct sensorsStruct | SensorsStruct |
| wrap sensors More... | |
Enumerations | |
| enum | SensorKindEnum { sensorClassTypeEnum = 0 , chainClassTypeEnum = 1 } |
Functions | |
| boolean | topicInIncludeGroup (char *topic) |
| void | setIncludeGroups (char *groups) |
| 8.2.24 set the include group (and cache it), called from MQTT More... | |
| void | initPreferencesMainModule () |
| initialize the _preferencesMainLookup with EPROM lookup names More... | |
| void | printPreferenceValues_mainModule () |
| print the preferences to SerialDebug More... | |
| void | initAppendingPreference_mainModule (int preferenceID) |
| called to init the preference. This won't save anything until storePreference called More... | |
| void | appendPreference_mainModule (int preferenceID, String preferenceValue) |
| called to append to a a preference (which will be an identifier and a string, which can be converted to a number or boolean) More... | |
| void | storePreference_mainModule (int preferenceID, String preferenceValue) |
| called to append to a a preference (which will be an identifier and a string, which can be converted to a number or boolean) More... | |
| void | resetPreference_mainModule (int preferenceID) |
| called to reset to blank a preference (which will be an identifier and a string, which can be converted to a number or boolean) More... | |
| void | savePreference_mainModule (int preferenceID, String preferenceValue) |
| called to set a preference (which will be an identifier and a string, which can be converted to a number or boolean) More... | |
| boolean | getPreferenceBoolean_mainModule (int preferenceID) |
| called to set a preference (which will be an identifier and a string, which can be converted to a number or boolean) More... | |
| void | savePreferenceBoolean_mainModule (int preferenceID, boolean flag) |
| save a boolean preference More... | |
| void | togglePreferenceBoolean_mainModule (int preferenceID) |
| toggles a preference boolean More... | |
| char * | getPreference_mainModule (int preferenceID) |
| char * | getPreferenceString_mainModule (int preferenceID) |
| returns the preference but in it's own string buffer. As long as you use it before calling getPreferenceString again, it won't be overwritten More... | |
| int | getPreferenceInt_mainModule (int preferenceID) |
| called to get a preference (which will be an identifier and a string, which can be converted to a number or boolean) More... | |
| void | savePreferenceInt_mainModule (int preferenceID, int val) |
| sets an int More... | |
| void | savePreferenceIntFromString_mainModule (int preferenceID, char *val) |
| sets an int, but only if a valid integer, and no signs More... | |
| float | getPreferenceFloat_mainModule (int preferenceID) |
| called to get a preference (which will be an identifier and a string, which can be converted to a number or boolean) More... | |
| void | savePreferenceFloat_mainModule (int preferenceID, float val) |
| called to set a preference (which will be an identifier and a string, which can be converted to a number or boolean) More... | |
| void | setOnBootPreferences_mainModule () |
| set some defaults on boot - that override EPROM this can be called on the HOME screen to set back to normal mode.. More... | |
| boolean | isValidPairedDevice_mainModule () |
| returns if the paired device is not NONE More... | |
| char * | getPairedDevice_mainModule () |
| returns if the paired device is not NONE More... | |
| char * | getPairedDeviceAddress_mainModule () |
| returns if the paired device is not NONE More... | |
| char * | getPairedDeviceOrAddress_mainModule () |
| returns if the paired device is not NONE .. returns address or device More... | |
| void | resetAllPreferences_mainModule () |
| resets preferences.. Currently only reset all, but eventually reset(groups..) More... | |
| void | setDiscoverM5PTClicker (boolean flag) |
| boolean | getDiscoverM5PTClicker () |
| get option More... | |
| void | savePreferenceATOMKind_MainModule (String value) |
| new 1.4.24 setting ATOM kind (eg. M5AtomSocket, M5AtomScanner). MQTT message "set":"M5AtomKind", val= More... | |
| char * | getPreferenceATOMKind_MainModule () |
| new 1.4.24 setting ATOM kind (eg. M5AtomSocket, M5AtomScanner) More... | |
| int | getM5ATOMKind_MainModule () |
| new 1.4.24 setting ATOM kind (eg. ATOM_KIND_M5_SCANNER, ATOM_KIND_M5_SOCKET) More... | |
| SensorsStruct * | getSensors_mainModule () |
| return the sensor specified or null More... | |
| SensorStruct * | getSensor_mainModule (char *sensorName) |
| return the sensor specified or null More... | |
| void | setSensorsString_mainModule (char *sensorsString) |
| void | initSensorStringsFromEPROM_mainModule () |
| void | printSensors_mainModule (SensorsStruct *sensors) |
| print sensors, passing in a struct More... | |
| ChainUseStruct * | getChainUseStruct_mainModule () |
| get the chain struct More... | |
| void | registerChain_mainModule (String classType, int buttonNumber, int pressKind, String setString, String valString, String deviceString) |
| void | setChainSensorsString_mainModule (char *sensorsString) |
| void | initChainSensorStringsFromEPROM_mainModule () |
| void | printChainSensors_mainModule (ChainUseStruct *chainUseStruct) |
| print sensors, passing in a struct More... | |
| void | processChainButtonStruct (ChainButtonStruct *chainButtonStruct) |
| ChainButtonStruct * | getChainButtonStruct (int buttonNumber_1based, int pressKind) |
| void | setChainButtonStructSMART (char *valValue) |
| void | setChainButtonStructDOCFOLLOW (char *SMARTAddress) |
| void | requestChainSMARTButtons () |
Macro Definition Documentation
◆ ATOM_KIND_M5_SCANNER
| #define ATOM_KIND_M5_SCANNER 0 |
returned from mainModule
Definition at line 272 of file PreferencesController.h.
◆ ATOM_KIND_M5_SOCKET
| #define ATOM_KIND_M5_SOCKET 1 |
Definition at line 273 of file PreferencesController.h.
◆ BUTTON_ANY
| #define BUTTON_ANY -1 |
Definition at line 352 of file PreferencesController.h.
◆ BUTTON_DOUBLE_PRESS
| #define BUTTON_DOUBLE_PRESS 2 |
Definition at line 355 of file PreferencesController.h.
◆ BUTTON_JOYSTICK_BOTTOM
| #define BUTTON_JOYSTICK_BOTTOM 103 |
Definition at line 360 of file PreferencesController.h.
◆ BUTTON_JOYSTICK_LEFT
| #define BUTTON_JOYSTICK_LEFT 100 |
map x,y to quadrants
Definition at line 357 of file PreferencesController.h.
◆ BUTTON_JOYSTICK_RIGHT
| #define BUTTON_JOYSTICK_RIGHT 102 |
Definition at line 359 of file PreferencesController.h.
◆ BUTTON_JOYSTICK_TOP
| #define BUTTON_JOYSTICK_TOP 101 |
Definition at line 358 of file PreferencesController.h.
◆ BUTTON_LONG_PRESS
| #define BUTTON_LONG_PRESS 1 |
Definition at line 354 of file PreferencesController.h.
◆ BUTTON_SHORT_PRESS
| #define BUTTON_SHORT_PRESS 0 |
Definition at line 353 of file PreferencesController.h.
◆ CHAIN_USE_MAX
| #define CHAIN_USE_MAX 20 |
7.9.25 reset SENSORS to default "BuzzerSensorClass,23,33,L9110S_DCStepperClass,21,25"
Definition at line 350 of file PreferencesController.h.
◆ MAX_MAIN_PREFERENCES
| #define MAX_MAIN_PREFERENCES 56 |
******* 1 greater than last value **** IMPORTANT *** and no gaps..
Definition at line 172 of file PreferencesController.h.
◆ NEW_SENSORS_PREFERENCE
| #define NEW_SENSORS_PREFERENCE |
Definition at line 279 of file PreferencesController.h.
◆ PREFERENCE_ATOM_KIND_SETTING
| #define PREFERENCE_ATOM_KIND_SETTING 41 |
1.4.24 What kind of ATOM plug (set, M5AtomKind, val= {M5AtomSocket, M5AtomScanner}
Definition at line 115 of file PreferencesController.h.
◆ PREFERENCE_ATOM_SOCKET_GLOBAL_ONOFF_SETTING
| #define PREFERENCE_ATOM_SOCKET_GLOBAL_ONOFF_SETTING 45 |
1.12.24 Whether the AtomSocket accepts global on/off messages
Definition at line 124 of file PreferencesController.h.
◆ PREFERENCE_ATOMS_SETTING
| #define PREFERENCE_ATOMS_SETTING 40 |
1.1.24 the preference for all the ATOM plugs (format: atomType:value} .. for now just use socket:on
Definition at line 112 of file PreferencesController.h.
◆ PREFERENCE_BLE_SERVER_USE_DEVICE_NAME_SETTING
| #define PREFERENCE_BLE_SERVER_USE_DEVICE_NAME_SETTING 25 |
if set, the BLE Server (like PTFeeder) will tack on the device name (or none if not defined).
Definition at line 61 of file PreferencesController.h.
◆ PREFERENCE_BLE_USE_DISCOVERED_PAIRED_DEVICE_SETTING
| #define PREFERENCE_BLE_USE_DISCOVERED_PAIRED_DEVICE_SETTING 26 |
if set, the BLE Client will look for its service base name (PTFeeder or PTClicker), but if that name also has an extension (:ScoobyDoo), and this is set, it will only connect if the PREFERENCE_PAIRED_DEVICE_SETTING has the same device name in the discovered name
Definition at line 64 of file PreferencesController.h.
◆ PREFERENCE_CHAIN_SENSORS_SETTING
| #define PREFERENCE_CHAIN_SENSORS_SETTING 55 |
12.21.25 Winter Solstice party .. issue #365 Object Oriented Sensors as well define the sensors (not sensorPlugs). MQTT: set:sensor, set:sensors
Definition at line 168 of file PreferencesController.h.
◆ PREFERENCE_DEBUG_INFO_SETTING
| #define PREFERENCE_DEBUG_INFO_SETTING 37 |
a place to put some kind of Last Will of what went wrong .. for now (> max tries)
Definition at line 101 of file PreferencesController.h.
◆ PREFERENCE_DEV_ONLY_SM_SETTING
| #define PREFERENCE_DEV_ONLY_SM_SETTING 38 |
adding AP_DEBUG_MODE to let others know that DEBUG eprom is available. Turn this OFF for non dev
9.28.23 #272 only show Semantic Markers that are sent directly to the device
Definition at line 106 of file PreferencesController.h.
◆ PREFERENCE_DEVICE_NAME_SETTING
| #define PREFERENCE_DEVICE_NAME_SETTING 21 |
the device name itself (6.6.22)
Definition at line 52 of file PreferencesController.h.
◆ PREFERENCE_DISPLAY_ON_BLANK_SCREEN_VALUE
| #define PREFERENCE_DISPLAY_ON_BLANK_SCREEN_VALUE 13 |
Display preferences - show messages on blank screen- boolean.
Definition at line 33 of file PreferencesController.h.
◆ PREFERENCE_DISPLAY_SCREEN_TIMEOUT_VALUE
| #define PREFERENCE_DISPLAY_SCREEN_TIMEOUT_VALUE 14 |
sets the timeout value
Definition at line 35 of file PreferencesController.h.
◆ PREFERENCE_FIRST_TIME_FEATURE_SETTING
| #define PREFERENCE_FIRST_TIME_FEATURE_SETTING 22 |
a firsttime feature flag (only 1 per build) 7.12.22 defaulting to TRUE
Definition at line 54 of file PreferencesController.h.
◆ PREFERENCE_GROUP_NAMES_SETTING
| #define PREFERENCE_GROUP_NAMES_SETTING 36 |
the preference setting group names to subscribe (but empty or # go to wildcard, this also supports wildcard in the future)
Definition at line 98 of file PreferencesController.h.
◆ PREFERENCE_HIGH_TEMP_POWEROFF_VALUE
| #define PREFERENCE_HIGH_TEMP_POWEROFF_VALUE 15 |
sets the max temp for a poweroff
Definition at line 37 of file PreferencesController.h.
◆ PREFERENCE_INCLUDE_GROUP_NAMES_SETTING
| #define PREFERENCE_INCLUDE_GROUP_NAMES_SETTING 49 |
8.2.24 don't change subscription but include these groups (eg. safeHouse,atlasDogs)
Definition at line 139 of file PreferencesController.h.
◆ PREFERENCE_IS_MINIMAL_MENU_SETTING
| #define PREFERENCE_IS_MINIMAL_MENU_SETTING 16 |
sets the max temp for a poweroff
Definition at line 39 of file PreferencesController.h.
◆ PREFERENCE_MAIN_BLE_CLIENT_VALUE
| #define PREFERENCE_MAIN_BLE_CLIENT_VALUE 2 |
Definition at line 14 of file PreferencesController.h.
◆ PREFERENCE_MAIN_BLE_SERVER_VALUE
| #define PREFERENCE_MAIN_BLE_SERVER_VALUE 1 |
Definition at line 13 of file PreferencesController.h.
◆ PREFERENCE_MAIN_GATEWAY_VALUE
| #define PREFERENCE_MAIN_GATEWAY_VALUE 0 |
These are the "preferenceID" in the calls below.. **** Preferences Setup, called from reading EPROM, and from someone saving a preference ****
Definition at line 12 of file PreferencesController.h.
◆ PREFERENCE_NO_BUTTON_CLICK_POWEROFF_SETTING
| #define PREFERENCE_NO_BUTTON_CLICK_POWEROFF_SETTING 17 |
sets stepper angle, a floating point number sets screentimeout if not button clicks (set,noclick,val,seconds) NO poweroff with the GATEWAY mode
Definition at line 43 of file PreferencesController.h.
◆ PREFERENCE_NOTIFY_BLE_DISCOVERY
| #define PREFERENCE_NOTIFY_BLE_DISCOVERY 33 |
starts the BLE Discovery notification process - which might be internal or externa (via messages).
Definition at line 88 of file PreferencesController.h.
◆ PREFERENCE_ONLY_GEN3_CONNECT_SETTING
| #define PREFERENCE_ONLY_GEN3_CONNECT_SETTING 23 |
if true, only BLEClient connect to GEN3 feeders..
Definition at line 56 of file PreferencesController.h.
◆ PREFERENCE_PAIRED_DEVICE_ADDRESS_SETTING
| #define PREFERENCE_PAIRED_DEVICE_ADDRESS_SETTING 30 |
the paired device for guest device feeding (6.6.22) .. but the Address 9.3.22
Definition at line 74 of file PreferencesController.h.
◆ PREFERENCE_PAIRED_DEVICE_SETTING
| #define PREFERENCE_PAIRED_DEVICE_SETTING 20 |
the paired device for guest device feeding (6.6.22)
Definition at line 50 of file PreferencesController.h.
◆ PREFERENCE_SCREEN_COLOR_SETTING
| #define PREFERENCE_SCREEN_COLOR_SETTING 24 |
ithe color of the screen 0..n
Definition at line 58 of file PreferencesController.h.
◆ PREFERENCE_SEMANTIC_MARKER_ZOOMED_VALUE
| #define PREFERENCE_SEMANTIC_MARKER_ZOOMED_VALUE 12 |
Display preferences (SemanticMarker etc) - boolean.
Definition at line 31 of file PreferencesController.h.
◆ PREFERENCE_SENDWIFI_WITH_BLE
| #define PREFERENCE_SENDWIFI_WITH_BLE 32 |
sends the WIFI to all except current device if set
Definition at line 85 of file PreferencesController.h.
◆ PREFERENCE_SENSOR_PIR_VALUE
| #define PREFERENCE_SENSOR_PIR_VALUE 11 |
Definition at line 29 of file PreferencesController.h.
◆ PREFERENCE_SENSOR_PLUGS_SETTING
| #define PREFERENCE_SENSOR_PLUGS_SETTING 51 |
issue #338 sensor definition (in work) This will be a string in JSON format with various PIN and BUS information
Definition at line 149 of file PreferencesController.h.
◆ PREFERENCE_SENSOR_TILT_VALUE
| #define PREFERENCE_SENSOR_TILT_VALUE 10 |
Sensor preferences.
Definition at line 28 of file PreferencesController.h.
◆ PREFERENCE_SENSORS_SETTING
| #define PREFERENCE_SENSORS_SETTING 52 |
5.14.25 Dead 5.14.74 Montana issue #365 Object Oriented Sensors as well define the sensors (not sensorPlugs). MQTT: set:sensor, set:sensors
Definition at line 154 of file PreferencesController.h.
◆ PREFERENCE_SM_COMMAND_PIR_OFF_SETTING
| #define PREFERENCE_SM_COMMAND_PIR_OFF_SETTING 44 |
1.11.24 The Semantic Marker command is sent on PIR, and the Command to send on OFF (or opposite)
Definition at line 122 of file PreferencesController.h.
◆ PREFERENCE_SM_COMMAND_PIR_SETTING
| #define PREFERENCE_SM_COMMAND_PIR_SETTING 43 |
1.10.24 The Semantic Marker command is sent on PIR, and the Command to send
Definition at line 120 of file PreferencesController.h.
◆ PREFERENCE_SM_ON_PIR_SETTING
| #define PREFERENCE_SM_ON_PIR_SETTING 42 |
1.10.24 Flag on whether a Semantic Marker command is sent on PIR, and the Command to send
Definition at line 118 of file PreferencesController.h.
◆ PREFERENCE_STEPPER_2FEED_SETTING
| #define PREFERENCE_STEPPER_2FEED_SETTING 54 |
9.3.25 back from LA, Horses out. Tyler on lap. Europe next week sets the 2feed option (go back and forth)
Definition at line 163 of file PreferencesController.h.
◆ PREFERENCE_STEPPER_ANGLE_FLOAT_SETTING
| #define PREFERENCE_STEPPER_ANGLE_FLOAT_SETTING 7 |
Definition at line 22 of file PreferencesController.h.
◆ PREFERENCE_STEPPER_AUTO_FEED_VALUE
| #define PREFERENCE_STEPPER_AUTO_FEED_VALUE 5 |
Definition at line 20 of file PreferencesController.h.
◆ PREFERENCE_STEPPER_AUTO_MOTOR_DIRECTION_SETTING
| #define PREFERENCE_STEPPER_AUTO_MOTOR_DIRECTION_SETTING 48 |
8.2.24 to let older Tumbler NOT do the auto direction (back and forth) Isue #332 it will set via message: autoMotorDirection {"set":"autoMotorDirection","val":"true"}
Definition at line 136 of file PreferencesController.h.
◆ PREFERENCE_STEPPER_BUZZER_VALUE
| #define PREFERENCE_STEPPER_BUZZER_VALUE 3 |
stepper preferences
Definition at line 17 of file PreferencesController.h.
◆ PREFERENCE_STEPPER_CLOCKWISE_MOTOR_DIRECTION_SETTING
| #define PREFERENCE_STEPPER_CLOCKWISE_MOTOR_DIRECTION_SETTING 50 |
retreives the motor direction| 1) = default, clockwise; 0 = REVERSE, counterclockwise 9.8.22 false = reverse == counterclockwise TRUE == default 8.18.24 this one changes ...
Definition at line 145 of file PreferencesController.h.
◆ PREFERENCE_STEPPER_FACTORY_CLOCKWISE_MOTOR_DIRECTION_SETTING
| #define PREFERENCE_STEPPER_FACTORY_CLOCKWISE_MOTOR_DIRECTION_SETTING 31 |
retreives the motor direction| 1) = default, clockwise; 0 = REVERSE, counterclockwise 9.8.22 false = reverse == counterclockwise TRUE == default 8.18.24 note this changes so you can switch directions. the FACTORY_CLOCKWISE below is the original one time setting. Renamed to FACTORY for backward compatible
Definition at line 82 of file PreferencesController.h.
◆ PREFERENCE_STEPPER_FEEDS_PER_JACKPOT
| #define PREFERENCE_STEPPER_FEEDS_PER_JACKPOT 9 |
Definition at line 25 of file PreferencesController.h.
◆ PREFERENCE_STEPPER_JACKPOT_FEED_VALUE
| #define PREFERENCE_STEPPER_JACKPOT_FEED_VALUE 6 |
Definition at line 21 of file PreferencesController.h.
◆ PREFERENCE_STEPPER_KIND_VALUE
| #define PREFERENCE_STEPPER_KIND_VALUE 8 |
uses STEPPER type
Definition at line 24 of file PreferencesController.h.
◆ PREFERENCE_STEPPER_RPM_SETTING
| #define PREFERENCE_STEPPER_RPM_SETTING 53 |
8.14.25 Dead Movie from 10.19.1974 tonight.. issue #394 stepperRPM stepper RPM
Definition at line 159 of file PreferencesController.h.
◆ PREFERENCE_STEPPER_SINGLE_FEED_VALUE
| #define PREFERENCE_STEPPER_SINGLE_FEED_VALUE 4 |
Definition at line 19 of file PreferencesController.h.
◆ PREFERENCE_SUB_DAWGPACK_SETTING
| #define PREFERENCE_SUB_DAWGPACK_SETTING 28 |
8.17.22 to turn on/off subscribing to the dawgpack topic
Definition at line 69 of file PreferencesController.h.
◆ PREFERENCE_SUPPORT_GROUPS_SETTING
| #define PREFERENCE_SUPPORT_GROUPS_SETTING 35 |
the preference for supporting GROUPS (default true)
Definition at line 94 of file PreferencesController.h.
◆ PREFERENCE_TIMER_INT_SETTING
| #define PREFERENCE_TIMER_INT_SETTING 34 |
the preference timer
Definition at line 91 of file PreferencesController.h.
◆ PREFERENCE_TIMER_MAX_INT_SETTING
| #define PREFERENCE_TIMER_MAX_INT_SETTING 39 |
the preference timer MAX (pairs with PREFERENCE_TIMER_INT_SETTING)
Definition at line 109 of file PreferencesController.h.
◆ PREFERENCE_USE_DOC_FOLLOW_SETTING
| #define PREFERENCE_USE_DOC_FOLLOW_SETTING 27 |
for
Definition at line 66 of file PreferencesController.h.
◆ PREFERENCE_USE_SPIFF_MQTT_SETTING
| #define PREFERENCE_USE_SPIFF_MQTT_SETTING 46 |
4.4.24 Adding SPIFF for MQTT and QRATOM seperately For MQTT writing to the SPIFF
Definition at line 128 of file PreferencesController.h.
◆ PREFERENCE_USE_SPIFF_QRATOM_SETTING
| #define PREFERENCE_USE_SPIFF_QRATOM_SETTING 47 |
For MQTT writing to the QRATOM.
Definition at line 130 of file PreferencesController.h.
◆ PREFERENCE_USE_SPIFF_SETTING
| #define PREFERENCE_USE_SPIFF_SETTING 29 |
8.22.22 to turn on/off SPIFF use (more below..)
Definition at line 71 of file PreferencesController.h.
◆ PREFERENCE_WIFI_CREDENTIAL_1_SETTING
| #define PREFERENCE_WIFI_CREDENTIAL_1_SETTING 18 |
Definition at line 47 of file PreferencesController.h.
◆ PREFERENCE_WIFI_CREDENTIAL_2_SETTING
| #define PREFERENCE_WIFI_CREDENTIAL_2_SETTING 19 |
Definition at line 48 of file PreferencesController.h.
◆ STEPPER_IS_MINI
| #define STEPPER_IS_MINI 2 |
Definition at line 8 of file PreferencesController.h.
◆ STEPPER_IS_TUMBLER
| #define STEPPER_IS_TUMBLER 3 |
Definition at line 9 of file PreferencesController.h.
◆ STEPPER_IS_UNO
| #define STEPPER_IS_UNO 1 |
Definition at line 7 of file PreferencesController.h.
◆ WIFI_CREDENTIALS_MAX
| #define WIFI_CREDENTIALS_MAX 2 |
for now, save 2 WIFI Credentials
Definition at line 46 of file PreferencesController.h.
Typedef Documentation
◆ SensorsStruct
| typedef struct sensorsStruct SensorsStruct |
wrap sensors
◆ SensorStruct
| typedef struct sensorStruct SensorStruct |
sensor struct defines the structure
Enumeration Type Documentation
◆ SensorKindEnum
| enum SensorKindEnum |
12.17.25 No Power. 1 tree down, HIGH winds last night, no flooding here, but valleys and roads bad extend the parser for different SensorKindEnum with different number of parameters and types (int vs str) There will be a setSensors (existing), and then a setM5Chain the new one.. it's own EPROM too the SensorKindEnum is what state we are holding. There will be state models behind each of these.
| Enumerator | |
|---|---|
| sensorClassTypeEnum | |
| chainClassTypeEnum | |
Definition at line 294 of file PreferencesController.h.
Function Documentation
◆ appendPreference_mainModule()
| void appendPreference_mainModule | ( | int | preferenceID, |
| String | preferenceValue | ||
| ) |
called to append to a a preference (which will be an identifier and a string, which can be converted to a number or boolean)
Definition at line 355 of file PreferencesController.cpp.
◆ getChainButtonStruct()
| ChainButtonStruct * getChainButtonStruct | ( | int | buttonNumber_1based, |
| int | pressKind | ||
| ) |
1.22.26 with puppies, cold dry outside get the ChainUseStruct for the buttonNumber (eg 1..9 (no 0) Column Major in the Matrix (but sequential here) return the definition for this 1 based button number (if any)] //TODO -1 pressKind = -1 (matches first one ..) NOTE: pressKind for Joystick is here.. 1.28.26 you can ask for BUTTON 0 (which will be the deault for the M5Atom single press (or maybe long press) 2.9.26 will only return if the button is finalized
1.27.26 moved here for generic use .. even by a non chain button 1.22.26 with puppies, cold dry outside get the ChainUseStruct for the buttonNumber (eg 1..9 (no 0) Column Major in the Matrix (but sequential here) return the definition for this 1 based button number (if any)] //TODO -1 pressKind = -1 (matches first one ..) NOTE: pressKind for Joystick is here.. 1.28.26 you can ask for BUTTON 0 (which will be the deault for the M5Atom single press (or maybe long press) 2.9.26 if not finlized yet, then request a smart definition.. in case not found yet.
go through looking for N one (0 based)
grab the i'th struct, then look at the button number and pressKind
i is just the entry .. not the button number N'th entry
see if the right pressKind
2.9.26 if not finalized .. ask again
found one .. go with it
not finalized yes .. so fire off a request again. make a request for the UUID ... {"set":"getSmartDefn", "val":"uuid.flownum"}
send MQTT message requesting a definiition for our SMART button send this message
and no match..
Definition at line 2455 of file PreferencesController.cpp.
◆ getChainUseStruct_mainModule()
| ChainUseStruct * getChainUseStruct_mainModule | ( | ) |
get the chain struct
get the chain struct
Definition at line 1745 of file PreferencesController.cpp.
◆ getDiscoverM5PTClicker()
| boolean getDiscoverM5PTClicker | ( | ) |
get option
Definition at line 1393 of file PreferencesController.cpp.
◆ getM5ATOMKind_MainModule()
| int getM5ATOMKind_MainModule | ( | ) |
new 1.4.24 setting ATOM kind (eg. ATOM_KIND_M5_SCANNER, ATOM_KIND_M5_SOCKET)
new 1.4.24 setting ATOM kind (eg. ATOM_KIND_M5_SCANNER, ATOM_KIND_M5_SOCKET) sets global _ATOM_KIND
optimize to only call this retrieval from EPROM 1 time.. unless changing the ATOMKind
Definition at line 1438 of file PreferencesController.cpp.
◆ getPairedDevice_mainModule()
| char * getPairedDevice_mainModule | ( | ) |
returns if the paired device is not NONE
Definition at line 1174 of file MainModule.cpp.
◆ getPairedDeviceAddress_mainModule()
| char * getPairedDeviceAddress_mainModule | ( | ) |
returns if the paired device is not NONE
Definition at line 1180 of file MainModule.cpp.
◆ getPairedDeviceOrAddress_mainModule()
| char * getPairedDeviceOrAddress_mainModule | ( | ) |
returns if the paired device is not NONE .. returns address or device
Definition at line 1205 of file MainModule.cpp.
◆ getPreference_mainModule()
| char * getPreference_mainModule | ( | int | preferenceID | ) |
called to get a preference (which will be an identifier and a string, which can be converted to a number or boolean) NOTE: this reuses same string buffer so will be overwritten on next call. Save value if you need more than one result (such as WIFI credentials, ouch) This mean any getPreference will use the same string .. so unless the result is a number or boolean, then copy it locally..
called to get a preference (which will be an identifier and a string, which can be converted to a number or boolean) Note: no CACHE is looked at here. It's up to the Boolean or Int to do that..
get from EPROM
Definition at line 425 of file PreferencesController.cpp.
◆ getPreferenceATOMKind_MainModule()
| char * getPreferenceATOMKind_MainModule | ( | ) |
new 1.4.24 setting ATOM kind (eg. M5AtomSocket, M5AtomScanner)
Definition at line 1430 of file PreferencesController.cpp.
◆ getPreferenceBoolean_mainModule()
| boolean getPreferenceBoolean_mainModule | ( | int | preferenceID | ) |
called to set a preference (which will be an identifier and a string, which can be converted to a number or boolean)
CACHE SETTINGS 5
Definition at line 444 of file PreferencesController.cpp.
◆ getPreferenceFloat_mainModule()
| float getPreferenceFloat_mainModule | ( | int | preferenceID | ) |
called to get a preference (which will be an identifier and a string, which can be converted to a number or boolean)
called to get a preference (which will be an identifier and a string, which can be converted to a number or boolean)
TODO: 8.18.24 add a cache for floats .. actially cache the string value??
Definition at line 512 of file PreferencesController.cpp.
◆ getPreferenceInt_mainModule()
| int getPreferenceInt_mainModule | ( | int | preferenceID | ) |
called to get a preference (which will be an identifier and a string, which can be converted to a number or boolean)
called to get a preference (which will be an identifier and a string, which can be converted to a number or boolean)
Definition at line 496 of file PreferencesController.cpp.
◆ getPreferenceString_mainModule()
| char * getPreferenceString_mainModule | ( | int | preferenceID | ) |
returns the preference but in it's own string buffer. As long as you use it before calling getPreferenceString again, it won't be overwritten
Definition at line 490 of file PreferencesController.cpp.
◆ getSensor_mainModule()
| SensorStruct * getSensor_mainModule | ( | char * | sensorName | ) |
return the sensor specified or null
Definition at line 1514 of file PreferencesController.cpp.
◆ getSensors_mainModule()
| SensorsStruct * getSensors_mainModule | ( | ) |
return the sensor specified or null
return the sensor specified or null
Definition at line 1508 of file PreferencesController.cpp.
◆ initAppendingPreference_mainModule()
| void initAppendingPreference_mainModule | ( | int | preferenceID | ) |
called to init the preference. This won't save anything until storePreference called
Preferences for the MainModule .. basically generic settings. So any settings you want, add them here. NOTE: These are just "state" values, no methods or events are generated on saving these values.. It's up to the caller to perform events such as turning on the buzzer..
Definition at line 350 of file PreferencesController.cpp.
◆ initChainSensorStringsFromEPROM_mainModule()
| void initChainSensorStringsFromEPROM_mainModule | ( | ) |
init the sensorString from EPROM PREFERENCE_SENSOR_PLUGS_SETTING
TODO add code here 1.23.26 storage for the chain sensors EPROM value .. PREFERENCE_CHAIN_SENSORS_SETTING FIRST do the registration maniually .. LATER .. parseSensros
Parse to the global.. TODO .. finish this (it should parse the structure like testParse() and do all the registerChain calls..
add this which is Button -0 (not a Chain button). So if a message comes in for button 0 .. it can find this one..
TODO: the following would use the testParse has to be after the _chainUseStruct global is set...
idea is you define the button and the press kind MatrixCell is Column Major 1,4, 7 // 2,5,8 // 3,6,9
joystick buttons..
1.24.26 don't know what to do yet ... x,y (or left, top, right, botton ??)
2.9.26 try the new smartDefn indirect button this has a future text with MQTT defined
2.16.26 runSmart will just send the runSmart, uuid.flownum .. and let someone else run it..
2.9.26 try the new smartDefn indirect button this has a future text with MQTT defined
3.20.26 Pinapple Express Rain, after Deep Snow last weekend, adding JC to button1 - incase it's the only one there.. This is because the button is known when it's touched .. so it searches numbered button for the Press kind (and joystick is seperate) TODO: check STORAGE
2.16.26 runSmart will just send the runSmart, uuid.flownum .. and let someone else run it..
2.9.26 try the new smartDefn indirect button this has a future text with MQTT defined
2.9.26 After Seahawks Superbowl Win #419 https://github.com/konacurrents/KSQRAvatar/issues/489 decide where the message shows up..
eg:
test...
request the chain buttons if SMART
Definition at line 1938 of file PreferencesController.cpp.
◆ initPreferencesMainModule()
| void initPreferencesMainModule | ( | ) |
initialize the _preferencesMainLookup with EPROM lookup names
initialize the _preferencesMainLookup with EPROM lookup names BUT these are not stored in EPROM. The next method
9.4.25 NOTE: tese are in case the EPROM wasn't set. So the EPROM is used over these values..
12.27.23 ON for all M5 (the reason is credentials ...)
12.8.22 default back TRUE default off for the M5 (but it can be turned on later..)
12.27.23 ON for most M5 , but off for the SOCKET
only the SOCKET will be off by default for now...
Sensor preferences
used for first time features..
This is a feeder that gateways to a GEN3
This is a feeder that gateways to a GEN3
REST ARE NOT CACHED
STEPPER preferences (no ifdef.. )
5.2.25 default 0.5 SECONDS (not angle for the HDriver
3.28.23 change default to 5 (from 30)
11.29.23 add a max so random can be used
8.15.26 default to the buzzer OFF
set with message: set:bleusedevicename,val:on/off
8.18.26 set default OFF
set with message: set:bleusepaireddevicename,val:on/off
used for first time features..
8.17.22 to turn on/off subscribing to the dawgpack topic
//! 8.22.22 to turn on/off SPIFF use (not cached yet as it's an infrequent event)
the paired device for guest device feeding (6.6.22) .. but the Address 9.3.22
!retreives the motor direction| 0 (false) = default, clockwise; 1 (true) = REVERSE, counterclockwise 9.8.22 TRUE = reverse == counterclockwise FALSE = default
8.18.24 the factory setting retreives the motor direction| 0 (false) = default, clockwise; 1 (true) = REVERSE, counterclockwise 9.8.22 TRUE = reverse == counterclockwise FALSE = default
10.4.22
11.1.22 TODO.. messages for this..
7.26.23 added group message support (or turn it off) PREFERENCE_SUPPORT_GROUPS_SETTING default OFF 1.15.24
7.26.23 added group message support (or turn it off) PREFERENCE_GROUP_NAMES_SETTING the preference setting group names to subscribe (but empty or # go to wildcard, this also supports wildcard in the future)
a place to put some kind of Last Will of what went wrong .. for now (> max tries) 9.16.23
9.28.23 #272 only show Semantic Markers that are sent directly to the device, default OFF
1.1.24 first version of preferences for the ATOMs depending on which ATOM kind first version, only the socket and the value is on/off syntaxURL socket=off&smscanner=on
1.4.24 What kind of ATOM plug (set, M5AtomKind, val= {M5AtomSocket, M5AtomScanner}
1.10.24 The Semantic Marker command is sent on PIR, and the Command to send
1.10.24 The Semantic Marker command is sent on PIR, and the Command to send
1.11.24 The Semantic Marker command is sent on PIR, and the Command to send for OFF
1.12.24 whether global on/off is allowed. Default on..
//! 4.4.24 to turn on/off SPIFF use (not cached yet as it's an infrequent event)
//! 4.4.24 to turn on/off SPIFF use (not cached yet as it's an infrequent event)
8.2.24 to let older Tumbler NOT do the auto direction (back and forth) Isue #332 it will set via message: autoMotorDirection {"set":"autoMotorDirection","val":"true"}
8.2.24 include these groups (or none) {"set":"includeGroups","val":"group1,group2"}
issue #338 sensor definition (in work) This will be a string in JSON format with various PIN and BUS information
12.21.25 Winter Solstice, Eagles, Party, these are the CHAIN_SENSORS
5.14.25 Dead 5.14.74 Montana issue #365 Object Oriented Sensors as well define the sensors (not sensorPlugs). MQTT: set:sensor, set:sensors 7.9.25 default to BuzzerSensorClass and L9110S_DCStepperClass
8.14.25 Dead Movie from 10.19.1974 tonight.. issue #394 stepperRPM stepper RPM
9.3.25 Dead Movie.. let it grow
Definition at line 683 of file PreferencesController.cpp.
◆ initSensorStringsFromEPROM_mainModule()
| void initSensorStringsFromEPROM_mainModule | ( | ) |
init the sensorString from EPROM PREFERENCE_SENSOR_PLUGS_SETTING
Parse to the global..
Definition at line 1567 of file PreferencesController.cpp.
◆ isValidPairedDevice_mainModule()
| boolean isValidPairedDevice_mainModule | ( | ) |
returns if the paired device is not NONE
returns if the paired device is not NONE
Definition at line 1186 of file MainModule.cpp.
◆ printChainSensors_mainModule()
| void printChainSensors_mainModule | ( | ChainUseStruct * | chainUseStruct | ) |
print sensors, passing in a struct
print sensors, passing in a struct also makes a requestChainSMARTButtons() call ..
print it 2 ways, one as the EPROM wouild look, the other are the chain use string
go through looking for N one (0 based)
grab the i'th struct, then look at the button number and pressKind
"JC", 3, BUTTON_JOYSTICK_RIGHT, "feed", "", "" );
request the chain buttons if SMART
Definition at line 2078 of file PreferencesController.cpp.
◆ printPreferenceValues_mainModule()
| void printPreferenceValues_mainModule | ( | ) |
print the preferences to SerialDebug
this inits the string to the EPROM value
12.24.25 return the username and password, Kevin feature .. he was setting to WIFI acidently. I updated APP to make that harder note on reboot this won't be set until later, so do another ""
don't change subscription but include these groups (eg. safeHouse,atlasDogs)
1.10.24 Flag on whether a Semantic Marker command is sent on PIR, and the Command to send
1.10.24 The Semantic Marker command is sent on PIR, and the Command to send
1.11.24 The Semantic Marker command is sent on PIR, and the Command to send
1.12.24 The Semantic Marker command is sent on PIR, and the Command to send
5.14.25
12.21.25 5.14.25
8.14.25 Dead Movie from 10.19.1974 tonight.. issue #394 stepperRPM stepper RPM
9.3.25 back from LA, Horses out. Tyler on lap. Europe next week sets the 2feed option (go back and forth)
retrieve a JSON string for the ssid and ssid_password: {'ssid':<ssid>,'ssidPassword':<pass>"}
5.14.25 also print out the sensors print sensors
4.28.26 home alone with Tyler and Spike. Kids Q&A comming over for Spaghetti print the retrieve the Configuration JSON string in JSON format..
1.24.26 Clear day .. 2 eagles again on walk
7.31.25
TODO: add preference to not support this?? show example JSON (break up as getPreference re-uses same string...
7.31.25 PIN USE
this needs to have a long pin in the array as well 8.30.25 check if duplicates
Definition at line 1172 of file PreferencesController.cpp.
◆ printSensors_mainModule()
| void printSensors_mainModule | ( | SensorsStruct * | sensors | ) |
print sensors, passing in a struct
Definition at line 1492 of file PreferencesController.cpp.
◆ processChainButtonStruct()
| void processChainButtonStruct | ( | ChainButtonStruct * | chainButtonStruct | ) |
7.9.25 reset SENSORS to default "BuzzerSensorClass,23,33,L9110S_DCStepperClass,21,25" 1.22.26 Dead Morning Dew process the given button 1.24.26 NOTE: this doesn't care about button press or joystick .. it's just run that button
1.22.26 Dead Morning Dew process the given button 1.24.26 NOTE: this doesn't care about button press or joystick .. it's just run that button
1.24.26 look at $options
special
4.3.26 if BLE connected .. just do that..
send a BLE feed command as we are connected
feed .. feed always (done after the code below..)
This will send BLE to our connected device ..
4.3.26 Off to the Moon if "feed" then send via BLE and WIFI
8.16.25 BLE CLIENT
9.30.22 IF SET .. send a feed but to all devices except ours and our pair (if any) uses new wildcard syntax either ! OUR NAME [ & ! OUR_CONNECTED_NAME
feed always (done after the code below..)
create a set/val message TODO; device, etc.. topic eg. registerChain_mainModule("BC", 1, BUTTON_DOUBLE_PRESS, "feed", "", "" ); //wifi
create a set/val message TODO; device, etc.. topic
send this message
idea is you define the button and the press kind MatrixCell is Column Major 1,4, 7 // 2,5,8 // 3,6,9
Definition at line 2593 of file PreferencesController.cpp.
◆ registerChain_mainModule()
| void registerChain_mainModule | ( | String | classType, |
| int | buttonNumber, | ||
| int | pressKind, | ||
| String | setString, | ||
| String | valString, | ||
| String | deviceString | ||
| ) |
12.19.25 use the Chain 5.3.25 add a central clearing house for defining PIN use central clearing house for all pins used to we can analyze if there are overlaps pin is the actual number, pinName is the local name (eg. IN1_PIN or VIN_PIN). moduleName is the module in the code, isI2C is whether this is a I2C bus (which we aren't using much yet) 1.22.26 add pressKind and classType
storage is supposed to have been created .. but this line blows ..
update the n'th version grab a pointer to the size already created The array is really contiguous memory .. vs linked list, to the address of the n't array is the pointer to that struct grab the next entry (chainUseCount)
1.23.26 5.3.25 create storage here
store globally
store classType
set the buttonNumber for this chain #
pressKind
set the set for this chain #
set the set for this chain #
set the set for this chain #
2.11.26
2.9.26 superbowl, raining out fi the set is $SMART then do something ... request the value again .. since otherwise the setString value would be changed $SMART, UUID.FLOW, <dev>
set the SMARTAddress
not finalized (not BOUND to the MQTT message. the iPhone is the one providing that information ...
2.11.26 add the docfollow $DC,, <nill args)> TODO: args: $DC, <group>, <name> help filter out $DC subsets (context)
2.11.26
no smart address
but finalized
no smart address
but finalized
increment chainUseCound
Definition at line 2298 of file PreferencesController.cpp.
◆ requestChainSMARTButtons()
| void requestChainSMARTButtons | ( | ) |
2.9.26 Rain. puppies still couple more days call this to ask for SMART Addresses .. when MQTT is connected this looks at all Chain Buttons and if a SMART Address .. requests on MQTT via set: getSmartDefn message 2.14.26 WORKS .. dynamic binding .. but now add a cache of last results (would have to reboot to clear cache)
2.9.26 SuperBowl win, Vonn crash send the request message again.. This will only be set if the setString wasn't updated .. 2.9.26 Rain. puppies still couple more days call this to ask for SMART Addresses .. when MQTT is connected this looks at all Chain Buttons and if a SMART Address .. requests on MQTT via set: getSmartDefn message TODO: 2.14.26 WORKS .. dynamic binding .. but now add a cache of last results (would have to reboot to clear cache)
go through all chain buttons and see if any are $SMART if so .. make a MQTT request
go through looking for N one (0 based)
grab the i'th struct, then look at the button number and pressKind
2.9.26 SuperBowl win, Vonn crash (5 inch hit gate) send the request message again.. This will only be set if the setString wasn't updated ..
2.14.26 Valentimes day, 46th with Laura Babe if already cached .. skip the request
not finalized yes .. so fire off a request again. make a request for the UUID ... {"set":"getSmartDefn", "val":"uuid.flownum"}
send MQTT message requesting a definiition for our SMART button send this message
Definition at line 2158 of file PreferencesController.cpp.
◆ resetAllPreferences_mainModule()
| void resetAllPreferences_mainModule | ( | ) |
resets preferences.. Currently only reset all, but eventually reset(groups..)
dispatches a call to the command specified. This is run on the next loop()
Definition at line 1373 of file PreferencesController.cpp.
◆ resetPreference_mainModule()
| void resetPreference_mainModule | ( | int | preferenceID | ) |
called to reset to blank a preference (which will be an identifier and a string, which can be converted to a number or boolean)
Definition at line 381 of file PreferencesController.cpp.
◆ savePreference_mainModule()
| void savePreference_mainModule | ( | int | preferenceID, |
| String | preferenceValue | ||
| ) |
called to set a preference (which will be an identifier and a string, which can be converted to a number or boolean)
Definition at line 322 of file PreferencesController.cpp.
◆ savePreferenceATOMKind_MainModule()
| void savePreferenceATOMKind_MainModule | ( | String | value | ) |
new 1.4.24 setting ATOM kind (eg. M5AtomSocket, M5AtomScanner). MQTT message "set":"M5AtomKind", val=
new 1.4.24 setting ATOM kind (eg. M5AtomSocket, M5AtomScanner). MQTT message "set":"M5AtomKind", val=
new 1.4.24 setting ATOM kind (eg. M5AtomSocket, M5AtomScanner) 1.5.24 also set the initial atom storage Then the device reboots.. so setup() and loop() are for the correct ATOM
1.5.24 also set the initial atom storage 1.4.24 use the _atomKind (which CAN change)
8.1.23 for the ATOM Lite QRCode Reader
12.26.23 for the ATOM Socket Power
Definition at line 1408 of file PreferencesController.cpp.
◆ savePreferenceBoolean_mainModule()
| void savePreferenceBoolean_mainModule | ( | int | preferenceID, |
| boolean | flag | ||
| ) |
save a boolean preference
TODO: put them in somewhere that is saving EPROM .. a SettingsModule these are implemented in the MainModule (since they are writing to the EPROM) sets and gets the "gateway" functionality
CACHE SETTINGS 5
Definition at line 472 of file PreferencesController.cpp.
◆ savePreferenceFloat_mainModule()
| void savePreferenceFloat_mainModule | ( | int | preferenceID, |
| float | val | ||
| ) |
called to set a preference (which will be an identifier and a string, which can be converted to a number or boolean)
convert to a string..
Definition at line 521 of file PreferencesController.cpp.
◆ savePreferenceInt_mainModule()
| void savePreferenceInt_mainModule | ( | int | preferenceID, |
| int | val | ||
| ) |
sets an int
sets an int
CACHE SETTINGS 1
convert to a string..
Definition at line 391 of file PreferencesController.cpp.
◆ savePreferenceIntFromString_mainModule()
| void savePreferenceIntFromString_mainModule | ( | int | preferenceID, |
| char * | val | ||
| ) |
sets an int, but only if a valid integer, and no signs
sets an int, but only if a valid integer, and no signs
Definition at line 406 of file PreferencesController.cpp.
◆ setChainButtonStructDOCFOLLOW()
| void setChainButtonStructDOCFOLLOW | ( | char * | SMARTAddress | ) |
2.11.26 Lincolns birtyday will set any buttons with DOCFOLLOW with the smart address specified
2.12.26 Lincolns birtyday, SKI crystal nice turns will set any buttons with DOCFOLLOW with the smart address specified $SMART, uuid.flow, dev here the smartAddress == UUID.FLOWNUM SMARTAddress is temporary transient storage
go through all chain buttons and see if any are $SMART if so .. make a MQTT request
go through looking for N one (0 based)
grab the i'th struct, then look at the button number and pressKind
the SMART Address is when finalized, so the same button can be updated in the future with just the address UUID.FLOW
change the DOCFOLLOW to a SMART item..
buttonFinalized means we have the MQTT message definition (retrieved from the internet, actually iPhone sends the setSmartDefn message If finalized then the SMARTAddress is what you want to use, which will
update the chain use for this one.. eg: "$SMART", "QHmwUurxC3.1769990960124", ""
since DOCFOLLOW all have the same, we can use the same (FOR NOW.. TODO : if the <cat> is used .. then different buffers needed..
print it out ...
Definition at line 2232 of file PreferencesController.cpp.
◆ setChainButtonStructSMART()
| void setChainButtonStructSMART | ( | char * | valValue | ) |
2.11.26 set the value for the smartAddress the val will be parsed..
2.11.26 set the value for the smartAddress the val will be parsed.. valValue is the address used: UUID.FLOW(set,val,dev) NOTE: valValue is transient storage
2.,10.26 parsing works .. no extra spaces .. UUID.FLOW(set,val,dev)
go through looking for N one (0 based)
grab the i'th struct, then look at the button number and pressKind
i is just the entry .. not the button number N'th entry
found one .. go with it
2.9.26 works.. but there might be multiple with same SMART address OOPS .. the getChainButtonStructSMART .. looks for matches .. this should be returning multiple BUT for now .. only the first one. NOTE: this is a chain button with a smart address .. which can be re-bound through this message..
for now .. set to the ToggleSocket
update the chain use for this one..
printout
Definition at line 2538 of file PreferencesController.cpp.
◆ setChainSensorsString_mainModule()
| void setChainSensorsString_mainModule | ( | char * | chainSensorsString | ) |
COPIED from template above.. Only 1 setSensorsString now .. will always append message: set:sensors, val:<val> or empty to clean it out unless a null or blank "" string set a sensor val (array of sensor,pin,pin,sensor,pin,pin...) After each set, the SensorsStruct will be updated
1.23.26 Clear Day .. puppies, tyler, Clear Snowy Mt Rainier
Only 1 setSensorsString now .. will always append unless a null or blank "" string PREFERENCE_CHAIN_SENSORS_SETTING set a sensor val (array of sensor,pin,pin,sensor,pin,pin...)
for now .. resetting 5.17.25
init EPROM
store in EPROM
Parse to the global..
printout
Definition at line 2038 of file PreferencesController.cpp.
◆ setDiscoverM5PTClicker()
| void setDiscoverM5PTClicker | ( | boolean | flag | ) |
transient for now... 10.4.22 set the M5 PTClicker discovery option..
Definition at line 1387 of file PreferencesController.cpp.
◆ setIncludeGroups()
| void setIncludeGroups | ( | char * | groups | ) |
8.2.24 set the include group (and cache it), called from MQTT
process the groups..
save persistently
Definition at line 312 of file PreferencesController.cpp.
◆ setOnBootPreferences_mainModule()
| void setOnBootPreferences_mainModule | ( | ) |
set some defaults on boot - that override EPROM this can be called on the HOME screen to set back to normal mode..
set some defaults on boot - that override EPROM This is also called when going back tot he MAIN menu (HOME SCREEN)
set zoomed = true (no semantic marker)
use the minimal menu on boot
Definition at line 539 of file PreferencesController.cpp.
◆ setSensorsString_mainModule()
| void setSensorsString_mainModule | ( | char * | sensorsString | ) |
Only 1 setSensorsString now .. will always append message: set:sensors, val:<val> or empty to clean it out unless a null or blank "" string set a sensor val (array of sensor,pin,pin,sensor,pin,pin...) After each set, the SensorsStruct will be updated
Only 1 setSensorsString now .. will always append unless a null or blank "" string set a sensor val (array of sensor,pin,pin,sensor,pin,pin...)
for now .. resetting 5.17.25
init EPROM
store in EPROM
Parse to the global..
Definition at line 1540 of file PreferencesController.cpp.
◆ storePreference_mainModule()
| void storePreference_mainModule | ( | int | preferenceID, |
| String | preferenceValue | ||
| ) |
called to append to a a preference (which will be an identifier and a string, which can be converted to a number or boolean)
turn AP_DEBUG_MODe off for now... 1.1.24 seems the append is goofing things..
Definition at line 365 of file PreferencesController.cpp.
◆ togglePreferenceBoolean_mainModule()
| void togglePreferenceBoolean_mainModule | ( | int | preferenceID | ) |
toggles a preference boolean
Definition at line 414 of file PreferencesController.cpp.
◆ topicInIncludeGroup()
| boolean topicInIncludeGroup | ( | char * | topic | ) |
8.2.24 retrieve the includeGroup really ask a topic if it's in the include group
8.2.24 retrieve the includeGroup really ask a topic if it's in the include group modifies the _
8.2.24 just string match for now.. NOTE: topic is a full path .. but MessageArrived: 'FEED {'deviceName':'MaggieMae'}', onTopic=usersP/groups/atlasDogs
find the topic (eg. usersP/groups/atlasDogs , is atlasDogs
go past the "/"
go through list..
empty is a find .. not specified
note "group" the short name is 2nd so it's asking if "/userP/groups/atlasDogs contains string atlasDogs that way the topic doesn't need to be parsed.. (although it could be wrong :eg atlas also matches..
Definition at line 231 of file PreferencesController.cpp.
