Spelling fixes (comments & variables)

This commit is contained in:
Faidon Liambotis 2023-07-16 16:19:05 +03:00
parent bc407b3613
commit 5b3f9f0d8c
28 changed files with 57 additions and 57 deletions

View File

@ -2,7 +2,7 @@
// https://www.online-utility.org/image/convert/to/XBM
// The output must be pasted in a header file, renamed and adjusted to appear
// as as a const unsigned char array in PROGMEM (FLASH program memory).
// as a const unsigned char array in PROGMEM (FLASH program memory).
// The xbm format adds padding to pixel rows so they are a whole number of bytes
// In this example 93 pixel width means 96 bits = 12 bytes

View File

@ -80,7 +80,7 @@ static String esp32ResetReason(uint8_t cpuid)
break; /**<13, RTC Watch dog Reset CPU*/
case 14:
resetReason += F("EXT_CPU");
break; /**<14, for APP CPU, reseted by PRO CPU*/
break; /**<14, for APP CPU, reset by PRO CPU*/
case 15:
resetReason += F("RTCWDT_BROWN_OUT");
break; /**<15, Reset when the vdd voltage is not stable*/
@ -108,7 +108,7 @@ Esp32Device::Esp32Device()
_backlight_invert = (TFT_BACKLIGHT_ON == LOW);
_backlight_power = 1;
_backlight_level = 255;
_backlight_pin = 255; // not TFT_BCKL because it is unkown at this stage
_backlight_pin = 255; // not TFT_BCKL because it is unknown at this stage
/* fill unique identifier with wifi mac */
byte mac[6];

View File

@ -86,7 +86,7 @@ void ArduinoGfx::init(int w, int h)
LOG_DEBUG(TAG_TFT, F("%s - %d"), __FILE__, __LINE__);
tft->begin(GFX_NOT_DEFINED);
LOG_DEBUG(TAG_TFT, F("%s - %d"), __FILE__, __LINE__);
// tft.setSwapBytes(true); /* set endianess */
// tft.setSwapBytes(true); /* set endianness */
LOG_INFO(TAG_TFT, F(D_SERVICE_STARTED));
}

View File

@ -978,7 +978,7 @@ void LovyanGfx::init(int w, int h)
LOG_DEBUG(TAG_TFT, F("%s - %d"), __FILE__, __LINE__);
tft.begin();
LOG_DEBUG(TAG_TFT, F("%s - %d"), __FILE__, __LINE__);
tft.setSwapBytes(true); /* set endianess */
tft.setSwapBytes(true); /* set endianness */
LOG_INFO(TAG_TFT, F(D_SERVICE_STARTED));
}

View File

@ -16,7 +16,7 @@ void TftEspi::init(int w, int h)
/* TFT init */
tft.begin();
tft.setSwapBytes(true); /* set endianess */
tft.setSwapBytes(true); /* set endianness */
}
void TftEspi::show_info()

View File

@ -77,7 +77,7 @@ class TouchGsl1680 : public BaseTouch {
// delay(300); // already happens in touch.begin()
touch_scan(Wire);
// Startup sequence CONTROLER part
// Startup sequence CONTROLLER part
TS.begin(TOUCH_RST, TOUCH_IRQ);
// Setup Interrupt handler

View File

@ -72,7 +72,7 @@
// break; /**<13, RTC Watch dog Reset CPU*/
// case 14:
// resetReason += F("EXT_CPU");
// break; /**<14, for APP CPU, reseted by PRO CPU*/
// break; /**<14, for APP CPU, reset by PRO CPU*/
// case 15:
// resetReason += F("RTCWDT_BROWN_OUT");
// break; /**<15, Reset when the vdd voltage is not stable*/
@ -234,12 +234,12 @@ int getMemFree() { // returns the amount of free memory in bytes
// #elif defined(ARDUINO_ARCH_ESP8266)
// return ESP.getFreeHeap();
// #else
// struct mallinfo chuncks = mallinfo();
// struct mallinfo chunks = mallinfo();
// // fordblks
// // This is the total size of memory occupied by free (not in use) chunks.
// return chuncks.fordblks + freeHighMemory();
// return chunks.fordblks + freeHighMemory();
// #endif
// }
@ -254,7 +254,7 @@ int getMemFree() { // returns the amount of free memory in bytes
// #endif
// }
String halGetMacAddress(int start, const char* seperator)
String halGetMacAddress(int start, const char* separator)
{
byte mac[6];
@ -278,7 +278,7 @@ String halGetMacAddress(int start, const char* seperator)
for(int i = start; i < 6; ++i) {
if(mac[i] < 0x10) cMac += "0";
cMac += String(mac[i], HEX);
if(i < 5) cMac += seperator;
if(i < 5) cMac += separator;
}
cMac.toUpperCase();
return cMac;

View File

@ -13,7 +13,7 @@
// size_t halGetFreeHeap(void);
// String halGetCoreVersion(void);
// String halGetChipModel();
String halGetMacAddress(int start, const char* seperator);
String halGetMacAddress(int start, const char* separator);
// uint16_t halGetCpuFreqMHz(void);
// String halDisplayDriverName(void);
// String halGpioName(uint8_t gpio);

View File

@ -387,7 +387,7 @@ void haspReconnect()
// String progress_str((char *)0);
// Shows/hides the the global progress bar and updates the value
// Shows/hides the global progress bar and updates the value
void haspProgressVal(uint8_t val)
{
lv_obj_t* layer = lv_disp_get_layer_sys(NULL);
@ -818,7 +818,7 @@ bool haspGetConfig(const JsonObject& settings)
*
* Read the settings from json and sets the application variables.
*
* @note: data pixel should be formated to uint32_t RGBA. Imagemagick requirements.
* @note: data pixel should be formatted to uint32_t RGBA. Imagemagick requirements.
*
* @param[in] settings JsonObject with the config settings.
**/

View File

@ -82,7 +82,7 @@ void my_msgbox_map_clear(lv_obj_t* obj)
lv_btnmatrix_ext_t* ext_btnmatrix = (lv_btnmatrix_ext_t*)lv_obj_get_ext_attr(btnmatrix);
if(!ext_btnmatrix) return;
if(ext_btnmatrix->map_p != msgbox_default_map) // Dont clear the default btnmap
if(ext_btnmatrix->map_p != msgbox_default_map) // Don't clear the default btnmap
my_btnmatrix_map_clear(btnmatrix); // Clear the custom button map if it exists
}
@ -2326,7 +2326,7 @@ static hasp_attribute_type_t attribute_common_method(lv_obj_t* obj, uint16_t att
case ATTR_OPEN:
case ATTR_CLOSE:
if(!obj_check_type(obj, LV_HASP_DROPDOWN)) return HASP_ATTR_TYPE_NOT_FOUND;
event_reset_last_value_sent(); // Prevents manual selection bug because no manual 'down' occured
event_reset_last_value_sent(); // Prevents manual selection bug because no manual 'down' occurred
if(attr_hash == ATTR_OPEN)
lv_dropdown_open(obj);
else

View File

@ -84,7 +84,7 @@ void my_obj_set_template(lv_obj_t* obj, const char* text)
LOG_WARNING(TAG_ATTR, "Failed to allocate memory!");
}
// free the extended user_data when all properies are NULL
// free the extended user_data when all properties are NULL
static void my_prune_ext_tags(lv_obj_t* obj)
{
if(!obj || !obj->user_data.ext) return;
@ -96,7 +96,7 @@ static void my_prune_ext_tags(lv_obj_t* obj)
}
}
// create extended user_data properies object
// create extended user_data properties object
static hasp_ext_user_data_t* my_create_ext_tags(lv_obj_t* obj)
{
void* ext = hasp_calloc(1, sizeof(hasp_ext_user_data_t));

View File

@ -177,7 +177,7 @@ static inline bool dispatch_parse_button_attribute(const char* topic_p, const ch
objid = (uint8_t)num;
topic_p = pEnd;
if(*topic_p != '.') return false; // obligated seperator
if(*topic_p != '.') return false; // obligated separator
topic_p++;
hasp_process_attribute(pageid, objid, topic_p, payload, update);
@ -1312,7 +1312,7 @@ void dispatch_current_state(uint8_t source)
// Format filesystem and erase EEPROM
bool dispatch_factory_reset()
{
bool formated = true;
bool formatted = true;
bool erased = true;
bool cleared = true;
@ -1321,15 +1321,15 @@ bool dispatch_factory_reset()
#endif
#if HASP_USE_SPIFFS > 0 || HASP_USE_LITTLEFS > 0
formated = HASP_FS.format();
if(formated) filesystemSetupFiles();
formatted = HASP_FS.format();
if(formatted) filesystemSetupFiles();
#endif
#if HASP_USE_EEPROM > 0
erased = configClearEeprom();
#endif
return formated && erased && cleared;
return formatted && erased && cleared;
}
void dispatch_calibrate(const char*, const char*, uint8_t source)

View File

@ -215,7 +215,7 @@ void event_timer_refresh(lv_task_t* task)
* Get the hasp eventid for LV_EVENT_PRESSED, LV_EVENT_VALUE_CHANGED, LV_EVENT_LONG_PRESSED_REPEAT and
* LV_EVENT_RELEASED Also updates the sleep state and handles LV_EVENT_DELETE events
* @param obj pointer to a color picker
* @param event type of event that occured
* @param event type of event that occurred
* @param eventid returns the hasp eventid
*/
static bool translate_event(lv_obj_t* obj, lv_event_t event, uint8_t& eventid)
@ -367,7 +367,7 @@ static void log_event(const char* name, lv_event_t event)
/**
* Called when a press on the system layer is detected
* @param obj pointer to a button matrix
* @param event type of event that occured
* @param event type of event that occurred
*/
void first_touch_event_handler(lv_obj_t* obj, lv_event_t event)
{
@ -419,7 +419,7 @@ void swipe_event_handler(lv_obj_t* obj, lv_event_t event)
/**
* Called when a textarea is clicked
* @param obj pointer to a textarea object
* @param event type of event that occured
* @param event type of event that occurred
*/
void textarea_event_handler(lv_obj_t* obj, lv_event_t event)
{
@ -455,7 +455,7 @@ void textarea_event_handler(lv_obj_t* obj, lv_event_t event)
/**
* Called when a button-style object is clicked
* @param obj pointer to a button object
* @param event type of event that occured
* @param event type of event that occurred
*/
void generic_event_handler(lv_obj_t* obj, lv_event_t event)
{
@ -546,7 +546,7 @@ void generic_event_handler(lv_obj_t* obj, lv_event_t event)
/**
* Called when a object state is toggled on/off
* @param obj pointer to a switch object
* @param event type of event that occured
* @param event type of event that occurred
*/
void toggle_event_handler(lv_obj_t* obj, lv_event_t event)
{
@ -591,7 +591,7 @@ void toggle_event_handler(lv_obj_t* obj, lv_event_t event)
/**
* Called when a range value has changed
* @param obj pointer to a dropdown list or roller
* @param event type of event that occured
* @param event type of event that occurred
*/
void selector_event_handler(lv_obj_t* obj, lv_event_t event)
{
@ -670,7 +670,7 @@ void selector_event_handler(lv_obj_t* obj, lv_event_t event)
/**
* Called when a btnmatrix value has changed
* @param obj pointer to a dropdown list or roller
* @param event type of event that occured
* @param event type of event that occurred
*/
void alarm_event_handler(lv_obj_t* obj, lv_event_t event)
{
@ -714,7 +714,7 @@ void alarm_event_handler(lv_obj_t* obj, lv_event_t event)
/**
* Called when a btnmatrix value has changed
* @param obj pointer to a dropdown list or roller
* @param event type of event that occured
* @param event type of event that occurred
*/
void btnmatrix_event_handler(lv_obj_t* obj, lv_event_t event)
{
@ -749,7 +749,7 @@ void btnmatrix_event_handler(lv_obj_t* obj, lv_event_t event)
/**
* Called when a msgbox value has changed
* @param obj pointer to a dropdown list or roller
* @param event type of event that occured
* @param event type of event that occurred
*/
void msgbox_event_handler(lv_obj_t* obj, lv_event_t event)
{
@ -783,7 +783,7 @@ void msgbox_event_handler(lv_obj_t* obj, lv_event_t event)
/**
* Called when a slider or adjustable arc is clicked
* @param obj pointer to a slider
* @param event type of event that occured
* @param event type of event that occurred
*/
void slider_event_handler(lv_obj_t* obj, lv_event_t event)
{
@ -825,7 +825,7 @@ void slider_event_handler(lv_obj_t* obj, lv_event_t event)
/**
* Called when a color picker is clicked
* @param obj pointer to a color picker
* @param event type of event that occured
* @param event type of event that occurred
*/
void cpicker_event_handler(lv_obj_t* obj, lv_event_t event)
{

View File

@ -137,7 +137,7 @@ inline const char* obj_get_type_name(const lv_obj_t* obj)
* Check if an lvgl objecttype name corresponds to a given HASP object ID
* @param obj an lv_obj_t* of the object to check its type
* @param haspobjtype the HASP object ID to check against
* @return true or false wether the types match
* @return true or false whether the types match
* @note
*/
inline bool obj_check_type(const lv_obj_t* obj, lv_hasp_obj_type_t haspobjtype)

View File

@ -288,14 +288,14 @@ bool filesystemSetup(void)
// no SPIFFS settings, as settings depend on SPIFFS
// no Logging, because it depends on the configuration file
// Logging is defered until debugging has started
// Logging is deferred until debugging has started
// FS success or failure is printed at that time !
#if HASP_USE_SPIFFS > 0 || HASP_USE_LITTLEFS > 0
#if defined(ARDUINO_ARCH_ESP8266)
if(!HASP_FS.begin()) {
#else
if(HASP_FS.begin(false)) return true; // already formated
if(HASP_FS.begin(false)) return true; // already formatted
if(!HASP_FS.begin(true)) { // format partition
#endif

View File

@ -209,7 +209,7 @@ static inline void gui_init_filesystems()
#if LV_USE_FS_IF != 0
//_lv_fs_init(); // lvgl File System -- not needed, it done in lv_init() when LV_USE_FILESYSTEM is set
LOG_VERBOSE(TAG_LVGL, F("Filesystem : " D_SETTING_ENABLED));
lv_fs_if_init(); // auxilary file system drivers
lv_fs_if_init(); // auxiliary file system drivers
// filesystem_list_path("L:/");
lv_fs_file_t f;
@ -532,7 +532,7 @@ bool guiGetConfig(const JsonObject& settings)
*
* Read the settings from json and sets the application variables.
*
* @note: data pixel should be formated to uint32_t RGBA. Imagemagick requirements.
* @note: data pixel should be formatted to uint32_t RGBA. Imagemagick requirements.
*
* @param[in] settings JsonObject with the config settings.
**/
@ -675,7 +675,7 @@ static void gui_screenshot_to_file(lv_disp_drv_t* disp, const lv_area_t* area, l
*
* Flush buffer into a binary file.
*
* @note: data pixel should be formated to uint16_t RGB. Set by Bitmap header.
* @note: data pixel should be formatted to uint16_t RGB. Set by Bitmap header.
*
* @param[in] pFileName Output binary file name.
*
@ -738,7 +738,7 @@ static void gui_screenshot_to_both(lv_disp_drv_t* disp, const lv_area_t* area, l
*
* Flush buffer into a http client.
*
* @note: data pixel should be formated to uint16_t RGB. Set by Bitmap header.
* @note: data pixel should be formatted to uint16_t RGB. Set by Bitmap header.
*
**/
void guiTakeScreenshot()

View File

@ -4,7 +4,7 @@
/* ===========================================================================
- LOG_FATAL() - A fatal exception is caught, the program should halt with while(1){}
- LOG_ERROR() - An important but non-fatal error occured, this error should be checked and not ignored
- LOG_ERROR() - An important but non-fatal error occurred, this error should be checked and not ignored
- LOG_WARNING() - Send at the end of a function to indicate failure of the sub process, can be ignored
- LOG_TRACE() - Information at the START of an action to notify another function is now running
@ -192,7 +192,7 @@ bool debugGetConfig(const JsonObject& settings)
*
* Read the settings from json and sets the application variables.
*
* @note: data pixel should be formated to uint32_t RGBA. Imagemagick requirements.
* @note: data pixel should be formatted to uint32_t RGBA. Imagemagick requirements.
*
* @param[in] settings JsonObject with the config settings.
**/

View File

@ -745,7 +745,7 @@ bool mqttGetConfig(const JsonObject& settings)
*
* Read the settings from json and sets the application variables.
*
* @note: data pixel should be formated to uint32_t RGBA. Imagemagick requirements.
* @note: data pixel should be formatted to uint32_t RGBA. Imagemagick requirements.
*
* @param[in] settings JsonObject with the config settings.
**/

View File

@ -415,7 +415,7 @@ void mqtt_get_info(JsonDocument& doc)
*
* Read the settings from json and sets the application variables.
*
* @note: data pixel should be formated to uint32_t RGBA. Imagemagick requirements.
* @note: data pixel should be formatted to uint32_t RGBA. Imagemagick requirements.
*
* @param[in] settings JsonObject with the config settings.
**/

View File

@ -459,7 +459,7 @@ bool mqttGetConfig(const JsonObject& settings)
*
* Read the settings from json and sets the application variables.
*
* @note: data pixel should be formated to uint32_t RGBA. Imagemagick requirements.
* @note: data pixel should be formatted to uint32_t RGBA. Imagemagick requirements.
*
* @param[in] settings JsonObject with the config settings.
**/

View File

@ -673,7 +673,7 @@ void gpio_output_group_values(uint8_t group)
// SHOULD only by called from DISPATCH
// Update the normalized value of all group members
// Does not procude logging output
// Does not produce logging output
void gpio_set_normalized_group_values(hasp_update_value_t& value)
{
// Set all pins first, minimizes delays
@ -1001,7 +1001,7 @@ bool gpioGetConfig(const JsonObject& settings)
*
* Read the settings from json and sets the application variables.
*
* @note: data pixel should be formated to uint32_t RGBA. Imagemagick requirements.
* @note: data pixel should be formatted to uint32_t RGBA. Imagemagick requirements.
*
* @param[in] settings JsonObject with the config settings.
**/

View File

@ -676,7 +676,7 @@ bool wifiGetConfig(const JsonObject& settings)
*
* Read the settings from json and sets the application variables.
*
* @note: data pixel should be formated to uint32_t RGBA. Imagemagick requirements.
* @note: data pixel should be formatted to uint32_t RGBA. Imagemagick requirements.
*
* @param[in] settings JsonObject with the config settings.
**/

View File

@ -194,7 +194,7 @@ bool ftpGetConfig(const JsonObject& settings)
*
* Read the settings from json and sets the application variables.
*
* @note: data pixel should be formated to uint32_t RGBA. Imagemagick requirements.
* @note: data pixel should be formatted to uint32_t RGBA. Imagemagick requirements.
*
* @param[in] settings JsonObject with the config settings.
**/

View File

@ -2765,7 +2765,7 @@ bool httpGetConfig(const JsonObject& settings)
*
* Read the settings from json and sets the application variables.
*
* @note: data pixel should be formated to uint32_t RGBA. Imagemagick requirements.
* @note: data pixel should be formatted to uint32_t RGBA. Imagemagick requirements.
*
* @param[in] settings JsonObject with the config settings.
**/

View File

@ -2359,7 +2359,7 @@ bool httpGetConfig(const JsonObject& settings)
*
* Read the settings from json and sets the application variables.
*
* @note: data pixel should be formated to uint32_t RGBA. Imagemagick requirements.
* @note: data pixel should be formatted to uint32_t RGBA. Imagemagick requirements.
*
* @param[in] settings JsonObject with the config settings.
**/

View File

@ -120,7 +120,7 @@ bool mdnsGetConfig(const JsonObject& settings)
/**
* Reads the settings from json and sets the application variables.
* @note: data pixel should be formated to uint32_t RGBA. Imagemagick requirements.
* @note: data pixel should be formatted to uint32_t RGBA. Imagemagick requirements.
* @param[in] settings JsonObject with the config settings.
**/
bool mdnsSetConfig(const JsonObject& settings)

View File

@ -201,7 +201,7 @@ void otaEverySecond(void)
void otaSetup(void)
{
#if ESP_ARDUINO_VERSION_MAJOR >= 2
/* This method is similar to the single root certificate verfication, but it uses a standard set of root
/* This method is similar to the single root certificate verification, but it uses a standard set of root
* certificates from Mozilla to authenticate against. This allows the client to connect to all public SSL
* servers. */
secureClient.setCACertBundle(rootca_crt_bundle_start);

View File

@ -209,7 +209,7 @@ static inline void telnetProcessData(char ch)
case 8: // Backspace
if(telnetInputIndex > 0) telnetInputIndex--;
break;
case 13: // Cariage Return
case 13: // Carriage Return
telnetProcessLine("");
break;
case 32 ... 250:
@ -444,7 +444,7 @@ bool telnetGetConfig(const JsonObject& settings)
*
* Read the settings from json and sets the application variables.
*
* @note: data pixel should be formated to uint32_t RGBA. Imagemagick requirements.
* @note: data pixel should be formatted to uint32_t RGBA. Imagemagick requirements.
*
* @param[in] settings JsonObject with the config settings.
**/