Skip to content

Commit

Permalink
lowercase method names
Browse files Browse the repository at this point in the history
  • Loading branch information
@thinkyhead
thinkyhead committed Jun 2, 2023
1 parent 6a4172a commit eb1dcb4
Show file tree
Hide file tree
Showing 14 changed files with 505 additions and 506 deletions.
68 changes: 34 additions & 34 deletions Marlin/src/lcd/extui/dgus_e3s1pro/DGUSDisplay.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,36 +50,36 @@ uint8_t DGUSDisplay::rx_datagram_len = 0;

bool DGUSDisplay::initialized = false;

void DGUSDisplay::Loop() {
ProcessRx();
void DGUSDisplay::loop() {
processRx();
}

void DGUSDisplay::Init() {
void DGUSDisplay::init() {
LCD_SERIAL.begin(LCD_BAUDRATE);

ReadVersions();
readVersions();
}

void DGUSDisplay::Read(uint16_t addr, uint8_t size) {
WriteHeader(addr, DGUS_READVAR, size);
void DGUSDisplay::read(uint16_t addr, uint8_t size) {
writeHeader(addr, DGUS_READVAR, size);

LCD_SERIAL.write(size);
}

void DGUSDisplay::Write(uint16_t addr, const void* data_ptr, uint8_t size) {
void DGUSDisplay::write(uint16_t addr, const void* data_ptr, uint8_t size) {
if (!data_ptr) return;

WriteHeader(addr, DGUS_WRITEVAR, size);
writeHeader(addr, DGUS_WRITEVAR, size);

const char* data = static_cast<const char*>(data_ptr);

while (size--) LCD_SERIAL.write(*data++);
}

void DGUSDisplay::WriteString(uint16_t addr, const void* data_ptr, uint8_t size, bool left, bool right, bool use_space) {
void DGUSDisplay::writeString(uint16_t addr, const void* data_ptr, uint8_t size, bool left, bool right, bool use_space) {
if (!data_ptr) return;

WriteHeader(addr, DGUS_WRITEVAR, size);
writeHeader(addr, DGUS_WRITEVAR, size);

const char* data = static_cast<const char*>(data_ptr);
size_t len = strlen(data);
Expand Down Expand Up @@ -111,10 +111,10 @@ void DGUSDisplay::WriteString(uint16_t addr, const void* data_ptr, uint8_t size,
while (right_spaces--) LCD_SERIAL.write(use_space ? ' ' : '\0');
}

void DGUSDisplay::WriteStringPGM(uint16_t addr, const void* data_ptr, uint8_t size, bool left, bool right, bool use_space) {
void DGUSDisplay::writeStringPGM(uint16_t addr, const void* data_ptr, uint8_t size, bool left, bool right, bool use_space) {
if (!data_ptr) return;

WriteHeader(addr, DGUS_WRITEVAR, size);
writeHeader(addr, DGUS_WRITEVAR, size);

const char* data = static_cast<const char*>(data_ptr);
size_t len = strlen_P(data);
Expand Down Expand Up @@ -144,63 +144,63 @@ void DGUSDisplay::WriteStringPGM(uint16_t addr, const void* data_ptr, uint8_t si
while (right_spaces--) LCD_SERIAL.write(use_space ? ' ' : '\0');
}

void DGUSDisplay::ReadVersions() {
void DGUSDisplay::readVersions() {
if (gui_version != 0 && os_version != 0) return;
Read(DGUS_VERSION, 1);
read(DGUS_VERSION, 1);
}

void DGUSDisplay::SwitchScreen(DGUS_Screen screen) {
void DGUSDisplay::switchScreen(DGUS_Screen screen) {
const uint8_t command[] = { 0x5A, 0x01, 0x00, (uint8_t)screen };
Write(0x84, command, sizeof(command));
write(0x84, command, sizeof(command));
}

void DGUSDisplay::PlaySound(uint8_t start, uint8_t len, uint8_t volume) {
void DGUSDisplay::playSound(uint8_t start, uint8_t len, uint8_t volume) {
if (volume == 0) volume = DGUSDisplay::volume;
else volume = map_precise(constrain(volume, 0, 100), 0, 100, 0, 0x40);

if (volume == 0) return;
const uint8_t command[] = { start, len, volume, 0x00 };
Write(0xA0, command, sizeof(command));
write(0xA0, command, sizeof(command));
}

void DGUSDisplay::EnableControl(DGUS_Screen screen, DGUS_ControlType type, DGUS_Control control) {
void DGUSDisplay::enableControl(DGUS_Screen screen, DGUS_ControlType type, DGUS_Control control) {
const uint8_t command[] = { 0x5A, 0xA5, 0x00, (uint8_t)screen, (uint8_t)control, type, 0x00, 0x01 };
Write(0xB0, command, sizeof(command));
write(0xB0, command, sizeof(command));

FlushTx();
flushTx();
delay(50);
}

void DGUSDisplay::DisableControl(DGUS_Screen screen, DGUS_ControlType type, DGUS_Control control) {
void DGUSDisplay::disableControl(DGUS_Screen screen, DGUS_ControlType type, DGUS_Control control) {
const uint8_t command[] = { 0x5A, 0xA5, 0x00, (uint8_t)screen, (uint8_t)control, type, 0x00, 0x00 };
Write(0xB0, command, sizeof(command));
write(0xB0, command, sizeof(command));

FlushTx();
flushTx();
delay(50);
}

uint8_t DGUSDisplay::GetBrightness() {
uint8_t DGUSDisplay::getBrightness() {
return brightness;
}

uint8_t DGUSDisplay::GetVolume() {
uint8_t DGUSDisplay::getVolume() {
return map_precise(volume, 0, 0x40, 0, 100);
}

void DGUSDisplay::SetBrightness(uint8_t new_brightness) {
void DGUSDisplay::setBrightness(uint8_t new_brightness) {
brightness = constrain(new_brightness, 0, 100);
new_brightness = map_precise(brightness, 0, 100, 5, 100);
const uint8_t command[] = { new_brightness, new_brightness };
Write(0x82, command, sizeof(command));
write(0x82, command, sizeof(command));
}

void DGUSDisplay::SetVolume(uint8_t new_volume) {
void DGUSDisplay::setVolume(uint8_t new_volume) {
volume = map_precise(constrain(new_volume, 0, 100), 0, 100, 0, 0x40);
const uint8_t command[] = { volume, 0x00 };
Write(0xA1, command, sizeof(command));
write(0xA1, command, sizeof(command));
}

void DGUSDisplay::ProcessRx() {
void DGUSDisplay::processRx() {

#if ENABLED(LCD_SERIAL_STATS_RX_BUFFER_OVERRUNS)
if (!LCD_SERIAL.available() && LCD_SERIAL.buffer_overruns()) {
Expand Down Expand Up @@ -344,7 +344,7 @@ void DGUSDisplay::ProcessRx() {
}
}

size_t DGUSDisplay::GetFreeTxBuffer() {
size_t DGUSDisplay::getFreeTxBuffer() {
return (
#ifdef LCD_SERIAL_GET_TX_BUFFER_FREE
LCD_SERIAL_GET_TX_BUFFER_FREE()
Expand All @@ -354,11 +354,11 @@ size_t DGUSDisplay::GetFreeTxBuffer() {
);
}

void DGUSDisplay::FlushTx() {
void DGUSDisplay::flushTx() {
TERN(ARDUINO_ARCH_STM32, LCD_SERIAL.flush(), LCD_SERIAL.flushTX());
}

void DGUSDisplay::WriteHeader(uint16_t addr, uint8_t command, uint8_t len) {
void DGUSDisplay::writeHeader(uint16_t addr, uint8_t command, uint8_t len) {
LCD_SERIAL.write(DGUS_HEADER1);
LCD_SERIAL.write(DGUS_HEADER2);
LCD_SERIAL.write(len + 3);
Expand Down
56 changes: 28 additions & 28 deletions Marlin/src/lcd/extui/dgus_e3s1pro/DGUSDisplay.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,66 +61,66 @@ class DGUSDisplay {

DGUSDisplay() = default;

static void Init();
static void init();

static void Read(uint16_t addr, uint8_t size);
static void Write(uint16_t addr, const void* data_ptr, uint8_t size);
static void read(uint16_t addr, uint8_t size);
static void write(uint16_t addr, const void* data_ptr, uint8_t size);

static void WriteString(uint16_t addr, const void* data_ptr, uint8_t size, bool left=true, bool right=false, bool use_space=true);
static void WriteStringPGM(uint16_t addr, const void* data_ptr, uint8_t size, bool left=true, bool right=false, bool use_space=true);
static void WriteString(uint16_t addr, FSTR_P const fstr, uint8_t size, bool left=true, bool right=false, bool use_space=true) {
WriteStringPGM(addr, FTOP(fstr), size, left, right, use_space);
static void writeString(uint16_t addr, const void* data_ptr, uint8_t size, bool left=true, bool right=false, bool use_space=true);
static void writeStringPGM(uint16_t addr, const void* data_ptr, uint8_t size, bool left=true, bool right=false, bool use_space=true);
static void writeString(uint16_t addr, FSTR_P const fstr, uint8_t size, bool left=true, bool right=false, bool use_space=true) {
writeStringPGM(addr, FTOP(fstr), size, left, right, use_space);
}

template<typename T>
static void Write(uint16_t addr, T data) {
Write(addr, static_cast<const void*>(&data), sizeof(T));
static void write(uint16_t addr, T data) {
write(addr, static_cast<const void*>(&data), sizeof(T));
}

// Until now I did not need to actively read from the display. That's why there is no ReadVariable
// (I extensively use the auto upload of the display)

// Read GUI and OS version from screen
static void ReadVersions();
static void readVersions();

// Force display into another screen.
static void SwitchScreen(DGUS_Screen screen);
static void switchScreen(DGUS_Screen screen);
// Play sounds using the display speaker.
// start: position at which the sound was stored on the display.
// len: how many sounds to play. Sounds will play consecutively from start to start+len-1.
// volume: playback volume. 0 keeps the current volume.
static void PlaySound(uint8_t start, uint8_t len=1, uint8_t volume=0);
static void playSound(uint8_t start, uint8_t len=1, uint8_t volume=0);
// Enable/disable a specific touch control.
// type: control type.
// control: index of the control on the page (set during screen development).
static void EnableControl(DGUS_Screen screen, DGUS_ControlType type, DGUS_Control control);
static void DisableControl(DGUS_Screen screen, DGUS_ControlType type, DGUS_Control control);
static void enableControl(DGUS_Screen screen, DGUS_ControlType type, DGUS_Control control);
static void disableControl(DGUS_Screen screen, DGUS_ControlType type, DGUS_Control control);

static uint8_t GetBrightness();
static uint8_t GetVolume();
static uint8_t getBrightness();
static uint8_t getVolume();

// Set the display brightness/volume, ranging 0 - 100
static void SetBrightness(uint8_t brightness);
static void SetVolume(uint8_t volume);
static void setBrightness(uint8_t brightness);
static void setVolume(uint8_t volume);

// Periodic tasks, eg. Rx-Queue handling.
static void Loop();
static void loop();

// Helper for users of this class to estimate if an interaction would be blocking.
static size_t GetFreeTxBuffer();
static void FlushTx();
static size_t getFreeTxBuffer();
static void flushTx();

// Checks two things: Can we confirm the presence of the display and has we initialized it.
// (both boils down that the display answered to our chatting)
static bool IsInitialized() {
static bool isInitialized() {
return initialized;
}

static uint8_t gui_version;
static uint8_t os_version;

template<typename T>
static T SwapBytes(const T value) {
static T swapBytes(const T value) {
union {
T val;
char byte[sizeof(T)];
Expand All @@ -132,12 +132,12 @@ class DGUSDisplay {
}

template<typename T_in, typename T_out, uint8_t decimals>
T_out FromFixedPoint(const T_in value) {
T_out fromFixedPoint(const T_in value) {
return (T_out)((float)value / POW(10, decimals));
}

template<typename T_in, typename T_out, uint8_t decimals>
T_out ToFixedPoint(const T_in value) {
T_out toFixedPoint(const T_in value) {
return (T_out)LROUND((float)value * POW(10, decimals));
}

Expand All @@ -163,8 +163,8 @@ class DGUSDisplay {
DGUS_VERSION = 0x000F // OS/GUI version
};

static void WriteHeader(uint16_t addr, uint8_t command, uint8_t len);
static void ProcessRx();
static void writeHeader(uint16_t addr, uint8_t command, uint8_t len);
static void processRx();

static uint8_t volume;
static uint8_t brightness;
Expand All @@ -175,7 +175,7 @@ class DGUSDisplay {
static bool initialized;
};

template<> inline uint16_t DGUSDisplay::SwapBytes(const uint16_t value) {
template<> inline uint16_t DGUSDisplay::swapBytes(const uint16_t value) {
return ((value << 8) | (value >> 8));
}

Expand Down
Loading

0 comments on commit eb1dcb4

Please sign in to comment.