Skip to content

TM1637 memory and code structure improvements #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DocMoebiuz merged 5 commits into from
Oct 21, 2023
Merged

TM1637 memory and code structure improvements #261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cef1f7d
Refactored and improved memory
DocMoebiuz Oct 20, 2023
f93aec8
memory improvement by converting enum to compiler define (28528)
DocMoebiuz Oct 20, 2023
248799f
memory improvement by encoder config logic: (28422)
DocMoebiuz Oct 20, 2023
366544a
Updated the head section of the files.
DocMoebiuz Oct 20, 2023
73ed51c
minor renaming for consistency with other classes
DocMoebiuz Oct 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 58 additions & 62 deletions src/Config.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,7 @@ bool readConfigLength()

while (MFeeprom.read_byte(addreeprom++) != 0x00) {
configLength++;
if (addreeprom > length)
{
if (addreeprom > length) {
cmdMessenger.sendCmd(kStatus, F("Loading config failed")); // text or "-1" like config upload?
return false;
}
Expand Down Expand Up @@ -209,8 +208,8 @@ bool readNameFromEEPROM(uint16_t *addreeprom, char *buffer, uint16_t *addrbuffer
if (*addrbuffer >= MEMLEN_NAMES_BUFFER) { // nameBuffer will be exceeded
return false; // abort copying from EEPROM to nameBuffer
}
} while (temp != ':'); // reads until limiter ':' and locates the next free buffer position
buffer[(*addrbuffer) - 1] = 0x00; // replace ':' by NULL, terminates the string
} while (temp != ':'); // reads until limiter ':' and locates the next free buffer position
buffer[(*addrbuffer) - 1] = 0x00; // replace ':' by NULL, terminates the string
return true;
}

Expand All @@ -223,13 +222,13 @@ bool readEndCommandFromEEPROM(uint16_t *addreeprom)
temp = MFeeprom.read_byte((*addreeprom)++);
if (*addreeprom > length) // abort if EEPROM size will be exceeded
return false;
} while (temp != ':'); // reads until limiter ':'
} while (temp != ':'); // reads until limiter ':'
return true;
}

void readConfig()
{
if (configLength == 0) // do nothing if no config is available
if (configLength == 0) // do nothing if no config is available
return;
uint16_t addreeprom = MEM_OFFSET_CONFIG; // define first memory location where config is saved in EEPROM
uint16_t addrbuffer = 0; // and start with first memory location from nameBuffer
Expand All @@ -238,7 +237,7 @@ void readConfig()
bool copy_success = true; // will be set to false if copying input names to nameBuffer exceeds array dimensions
// not required anymore when pins instead of names are transferred to the UI

if (command == 0) // just to be sure, configLength should also be 0
if (command == 0) // just to be sure, configLength should also be 0
return;

do // go through the EEPROM until it is NULL terminated
Expand All @@ -251,54 +250,55 @@ void readConfig()
break;

case kTypeOutput:
params[0] = readUintFromEEPROM(&addreeprom); // Pin number
params[0] = readUintFromEEPROM(&addreeprom); // Pin number
Output::Add(params[0]);
copy_success = readEndCommandFromEEPROM(&addreeprom); // check EEPROM until end of name
break;

#if MF_SEGMENT_SUPPORT == 1
case kTypeLedSegment:
params[0] = readUintFromEEPROM(&addreeprom); // Pin Data number
params[1] = readUintFromEEPROM(&addreeprom); // Pin CS number
params[2] = readUintFromEEPROM(&addreeprom); // Pin CLK number
params[3] = readUintFromEEPROM(&addreeprom); // brightness
params[4] = readUintFromEEPROM(&addreeprom); // number of modules
LedSegment::Add(params[0], params[1], params[2], params[4], params[3]);
// this is for backwards compatibility
case kTypeLedSegmentDeprecated:
// this is the new type
case kTypeLedSegmentMulti:
params[0] = LedSegment::TYPE_MAX72XX;
if (command == kTypeLedSegmentMulti)
params[0] = readUintFromEEPROM(&addreeprom); // Type of LedSegment

params[1] = readUintFromEEPROM(&addreeprom); // Pin Data number
params[2] = readUintFromEEPROM(&addreeprom); // Pin CS number
params[3] = readUintFromEEPROM(&addreeprom); // Pin CLK number
params[4] = readUintFromEEPROM(&addreeprom); // brightness
params[5] = readUintFromEEPROM(&addreeprom); // number of modules
LedSegment::Add(params[0], params[1], params[2], params[3], params[5], params[4]);
copy_success = readEndCommandFromEEPROM(&addreeprom); // check EEPROM until end of name
break;
#endif

#if MF_STEPPER_SUPPORT == 1
case kTypeStepperDeprecated1:
// this is for backwards compatibility
params[0] = readUintFromEEPROM(&addreeprom); // Pin1 number
params[1] = readUintFromEEPROM(&addreeprom); // Pin2 number
params[2] = readUintFromEEPROM(&addreeprom); // Pin3 number
params[3] = readUintFromEEPROM(&addreeprom); // Pin4 number
params[4] = readUintFromEEPROM(&addreeprom); // Button number
Stepper::Add(params[0], params[1], params[2], params[3], 0);
copy_success = readEndCommandFromEEPROM(&addreeprom); // check EEPROM until end of name
break;

case kTypeStepperDeprecated2:
params[0] = readUintFromEEPROM(&addreeprom); // Pin1 number
params[1] = readUintFromEEPROM(&addreeprom); // Pin2 number
params[2] = readUintFromEEPROM(&addreeprom); // Pin3 number
params[3] = readUintFromEEPROM(&addreeprom); // Pin4 number
params[4] = readUintFromEEPROM(&addreeprom); // Button number
Stepper::Add(params[0], params[1], params[2], params[3], params[4]);
copy_success = readEndCommandFromEEPROM(&addreeprom); // check EEPROM until end of name
break;

case kTypeStepper:
// Values for all stepper types
params[0] = readUintFromEEPROM(&addreeprom); // Pin1 number
params[1] = readUintFromEEPROM(&addreeprom); // Pin2 number
params[2] = readUintFromEEPROM(&addreeprom); // Pin3 number
params[3] = readUintFromEEPROM(&addreeprom); // Pin4 number
params[4] = readUintFromEEPROM(&addreeprom); // Button number
params[5] = readUintFromEEPROM(&addreeprom); // Stepper Mode
params[6] = readUintFromEEPROM(&addreeprom); // backlash
params[7] = readUintFromEEPROM(&addreeprom); // deactivate output

// Default values for older types
params[4] = (uint8_t)0; // Button number
params[5] = (uint8_t)0; // Stepper Mode
params[6] = (uint8_t)0; // backlash
params[7] = false; // deactivate output

if (command == kTypeStepperDeprecated2) {
params[4] = readUintFromEEPROM(&addreeprom); // Button number
}

if (command == kTypeStepper) {
params[5] = readUintFromEEPROM(&addreeprom); // Stepper Mode
params[6] = readUintFromEEPROM(&addreeprom); // backlash
params[7] = readUintFromEEPROM(&addreeprom); // deactivate output
}
// there is an additional 9th parameter stored in the config (profileID) which is not needed in the firmware
// and therefor not read in, it is just skipped like the name with reading until end of command
Stepper::Add(params[0], params[1], params[2], params[3], params[4], params[5], params[6], params[7]);
Expand All @@ -308,34 +308,30 @@ void readConfig()

#if MF_SERVO_SUPPORT == 1
case kTypeServo:
params[0] = readUintFromEEPROM(&addreeprom); // Pin number
params[0] = readUintFromEEPROM(&addreeprom); // Pin number
Servos::Add(params[0]);
copy_success = readEndCommandFromEEPROM(&addreeprom); // check EEPROM until end of name
break;
#endif

case kTypeEncoderSingleDetent:
params[0] = readUintFromEEPROM(&addreeprom); // Pin1 number
params[1] = readUintFromEEPROM(&addreeprom); // Pin2 number
Encoder::Add(params[0], params[1], 0, &nameBuffer[addrbuffer]); // MUST be before readNameFromEEPROM because readNameFromEEPROM returns the pointer for the NEXT Name
copy_success = readNameFromEEPROM(&addreeprom, nameBuffer, &addrbuffer); // copy the NULL terminated name to nameBuffer and set to next free memory location
// copy_success = readEndCommandFromEEPROM(&addreeprom); // once the nameBuffer is not required anymore uncomment this line and delete the line before
break;

case kTypeEncoder:
params[0] = readUintFromEEPROM(&addreeprom); // Pin1 number
params[1] = readUintFromEEPROM(&addreeprom); // Pin2 number
params[2] = readUintFromEEPROM(&addreeprom); // type
params[0] = readUintFromEEPROM(&addreeprom); // Pin1 number
params[1] = readUintFromEEPROM(&addreeprom); // Pin2 number
params[2] = 0; // type

if (command == kTypeEncoder)
params[2] = readUintFromEEPROM(&addreeprom); // type

Encoder::Add(params[0], params[1], params[2], &nameBuffer[addrbuffer]); // MUST be before readNameFromEEPROM because readNameFromEEPROM returns the pointer for the NEXT Name
copy_success = readNameFromEEPROM(&addreeprom, nameBuffer, &addrbuffer); // copy the NULL terminated name to to nameBuffer and set to next free memory location
// copy_success = readEndCommandFromEEPROM(&addreeprom); // once the nameBuffer is not required anymore uncomment this line and delete the line before
copy_success = readNameFromEEPROM(&addreeprom, nameBuffer, &addrbuffer); // copy the NULL terminated name to nameBuffer and set to next free memory location
break;

#if MF_LCD_SUPPORT == 1
case kTypeLcdDisplayI2C:
params[0] = readUintFromEEPROM(&addreeprom); // address
params[1] = readUintFromEEPROM(&addreeprom); // columns
params[2] = readUintFromEEPROM(&addreeprom); // lines
params[0] = readUintFromEEPROM(&addreeprom); // address
params[1] = readUintFromEEPROM(&addreeprom); // columns
params[2] = readUintFromEEPROM(&addreeprom); // lines
LCDDisplay::Add(params[0], params[1], params[2]);
copy_success = readEndCommandFromEEPROM(&addreeprom); // check EEPROM until end of name
break;
Expand All @@ -353,21 +349,21 @@ void readConfig()

#if MF_OUTPUT_SHIFTER_SUPPORT == 1
case kTypeOutputShifter:
params[0] = readUintFromEEPROM(&addreeprom); // latch Pin
params[1] = readUintFromEEPROM(&addreeprom); // clock Pin
params[2] = readUintFromEEPROM(&addreeprom); // data Pin
params[3] = readUintFromEEPROM(&addreeprom); // number of daisy chained modules
params[0] = readUintFromEEPROM(&addreeprom); // latch Pin
params[1] = readUintFromEEPROM(&addreeprom); // clock Pin
params[2] = readUintFromEEPROM(&addreeprom); // data Pin
params[3] = readUintFromEEPROM(&addreeprom); // number of daisy chained modules
OutputShifter::Add(params[0], params[1], params[2], params[3]);
copy_success = readEndCommandFromEEPROM(&addreeprom); // check EEPROM until end of name
break;
#endif

#if MF_INPUT_SHIFTER_SUPPORT == 1
case kTypeInputShifter:
params[0] = readUintFromEEPROM(&addreeprom); // latch Pin
params[1] = readUintFromEEPROM(&addreeprom); // clock Pin
params[2] = readUintFromEEPROM(&addreeprom); // data Pin
params[3] = readUintFromEEPROM(&addreeprom); // number of daisy chained modules
params[0] = readUintFromEEPROM(&addreeprom); // latch Pin
params[1] = readUintFromEEPROM(&addreeprom); // clock Pin
params[2] = readUintFromEEPROM(&addreeprom); // data Pin
params[3] = readUintFromEEPROM(&addreeprom); // number of daisy chained modules
InputShifter::Add(params[0], params[1], params[2], params[3], &nameBuffer[addrbuffer]);
copy_success = readNameFromEEPROM(&addreeprom, nameBuffer, &addrbuffer); // copy the NULL terminated name to to nameBuffer and set to next free memory location
// copy_success = readEndCommandFromEEPROM(&addreeprom); // once the nameBuffer is not required anymore uncomment this line and delete the line before
Expand Down
Loading