From 7612aad99a7f490173c81784a8b6d1c792f2452a Mon Sep 17 00:00:00 2001 From: Chris Date: Wed, 10 Oct 2018 09:20:34 +0200 Subject: [PATCH 1/4] Deletion of single u8 data Transfers and renaming of various functions command_with_data -> cmd_with_data command -> cmd multiple_data -> data --- src/epd1in54/mod.rs | 57 ++++++++--------- src/epd2in9/mod.rs | 61 +++++++----------- src/epd4in2/command.rs | 11 ++++ src/epd4in2/mod.rs | 89 +++++++++++---------------- src/interface/connection_interface.rs | 29 +++------ 5 files changed, 105 insertions(+), 142 deletions(-) diff --git a/src/epd1in54/mod.rs b/src/epd1in54/mod.rs index 0f282ca..93de08e 100644 --- a/src/epd1in54/mod.rs +++ b/src/epd1in54/mod.rs @@ -65,33 +65,30 @@ where // 0.. A[8] // 0.. B[2:0] // Default Values: A = Height of Screen (0x127), B = 0x00 (GD, SM and TB=0?) - self.interface.command(Command::DRIVER_OUTPUT_CONTROL)?; - self.interface.data(HEIGHT as u8)?; - self.interface.data((HEIGHT >> 8) as u8)?; - self.interface.data(0x00)?; + self.interface.cmd_with_data( + Command::DRIVER_OUTPUT_CONTROL, + &[HEIGHT as u8, (HEIGHT >> 8) as u8, 0x00] + )?; // 3 Databytes: (and default values from datasheet and arduino) // 1 .. A[6:0] = 0xCF | 0xD7 // 1 .. B[6:0] = 0xCE | 0xD6 // 1 .. C[6:0] = 0x8D | 0x9D //TODO: test - self.interface.command(Command::BOOSTER_SOFT_START_CONTROL)?; - self.interface.data(0xD7)?; - self.interface.data(0xD6)?; - self.interface.data(0x9D)?; + self.interface.cmd_with_data(Command::BOOSTER_SOFT_START_CONTROL, &[0xD7, 0xD6, 0x9D])?; // One Databyte with value 0xA8 for 7V VCOM - self.interface.command_with_data(Command::WRITE_VCOM_REGISTER, &[0xA8])?; + self.interface.cmd_with_data(Command::WRITE_VCOM_REGISTER, &[0xA8])?; // One Databyte with default value 0x1A for 4 dummy lines per gate - self.interface.command_with_data(Command::SET_DUMMY_LINE_PERIOD, &[0x1A])?; + self.interface.cmd_with_data(Command::SET_DUMMY_LINE_PERIOD, &[0x1A])?; // One Databyte with default value 0x08 for 2us per line - self.interface.command_with_data(Command::SET_GATE_LINE_WIDTH, &[0x08])?; + self.interface.cmd_with_data(Command::SET_GATE_LINE_WIDTH, &[0x08])?; // One Databyte with default value 0x03 // -> address: x increment, y increment, address counter is updated in x direction - self.interface.command_with_data(Command::DATA_ENTRY_MODE_SETTING, &[0x03])?; + self.interface.cmd_with_data(Command::DATA_ENTRY_MODE_SETTING, &[0x03])?; self.set_lut() } @@ -140,7 +137,7 @@ where fn sleep(&mut self) -> Result<(), E> { // 0x00 for Normal mode (Power on Reset), 0x01 for Deep Sleep Mode //TODO: is 0x00 needed here or would 0x01 be even more efficient? - self.interface.command_with_data(Command::DEEP_SLEEP_MODE, &[0x00])?; + self.interface.cmd_with_data(Command::DEEP_SLEEP_MODE, &[0x00])?; self.wait_until_idle(); Ok(()) @@ -152,7 +149,7 @@ where fn update_frame(&mut self, buffer: &[u8]) -> Result<(), E> { self.use_full_frame()?; - self.interface.command_with_data(Command::WRITE_RAM, buffer) + self.interface.cmd_with_data(Command::WRITE_RAM, buffer) } //TODO: update description: last 3 bits will be ignored for width and x_pos @@ -167,18 +164,18 @@ where self.set_ram_area(x, y, x + width, y + height)?; self.set_ram_counter(x, y)?; - self.interface.command_with_data(Command::WRITE_RAM, buffer) + self.interface.cmd_with_data(Command::WRITE_RAM, buffer) } fn display_frame(&mut self) -> Result<(), E> { // enable clock signal, enable cp, display pattern -> 0xC4 (tested with the arduino version) //TODO: test control_1 or control_2 with default value 0xFF (from the datasheet) - self.interface.command_with_data(Command::DISPLAY_UPDATE_CONTROL_2, &[0xC4])?; + self.interface.cmd_with_data(Command::DISPLAY_UPDATE_CONTROL_2, &[0xC4])?; - self.interface.command(Command::MASTER_ACTIVATION)?; + self.interface.cmd(Command::MASTER_ACTIVATION)?; // MASTER Activation should not be interupted to avoid currption of panel images // therefore a terminate command is send - self.interface.command(Command::NOP) + self.interface.cmd(Command::NOP) } fn clear_frame(&mut self) -> Result<(), E> { @@ -187,7 +184,7 @@ where // clear the ram with the background color let color = self.background_color.get_byte_value(); - self.interface.command(Command::WRITE_RAM)?; + self.interface.cmd(Command::WRITE_RAM)?; self.interface.data_x_times(color, WIDTH / 8 * HEIGHT) } @@ -235,25 +232,25 @@ where // x is positioned in bytes, so the last 3 bits which show the position inside a byte in the ram // aren't relevant - self.interface.command(Command::SET_RAM_X_ADDRESS_START_END_POSITION)?; - self.interface.data((start_x >> 3) as u8)?; - self.interface.data((end_x >> 3) as u8)?; + self.interface.cmd_with_data( + Command::SET_RAM_X_ADDRESS_START_END_POSITION, + &[(start_x >> 3) as u8, (end_x >> 3) as u8] + )?; // 2 Databytes: A[7:0] & 0..A[8] for each - start and end - self.interface.command(Command::SET_RAM_Y_ADDRESS_START_END_POSITION)?; - self.interface.data(start_y as u8)?; - self.interface.data((start_y >> 8) as u8)?; - self.interface.data(end_y as u8)?; - self.interface.data((end_y >> 8) as u8) + self.interface.cmd_with_data( + Command::SET_RAM_Y_ADDRESS_START_END_POSITION, + &[start_y as u8, (start_y >> 8) as u8, end_y as u8, (end_y >> 8) as u8] + ) } pub(crate) fn set_ram_counter(&mut self, x: u16, y: u16) -> Result<(), E> { // x is positioned in bytes, so the last 3 bits which show the position inside a byte in the ram // aren't relevant - self.interface.command_with_data(Command::SET_RAM_X_ADDRESS_COUNTER, &[(x >> 3) as u8])?; + self.interface.cmd_with_data(Command::SET_RAM_X_ADDRESS_COUNTER, &[(x >> 3) as u8])?; // 2 Databytes: A[7:0] & 0..A[8] - self.interface.command_with_data( + self.interface.cmd_with_data( Command::SET_RAM_Y_ADDRESS_COUNTER, &[ y as u8, @@ -281,7 +278,7 @@ where fn set_lut_helper(&mut self, buffer: &[u8]) -> Result<(), E> { assert!(buffer.len() == 30); - self.interface.command_with_data(Command::WRITE_LUT_REGISTER, buffer) + self.interface.cmd_with_data(Command::WRITE_LUT_REGISTER, buffer) } } diff --git a/src/epd2in9/mod.rs b/src/epd2in9/mod.rs index 90b5e02..5a86d83 100644 --- a/src/epd2in9/mod.rs +++ b/src/epd2in9/mod.rs @@ -64,42 +64,30 @@ where // 0.. A[8] // 0.. B[2:0] // Default Values: A = Height of Screen (0x127), B = 0x00 (GD, SM and TB=0?) - self.interface.command(Command::DRIVER_OUTPUT_CONTROL)?; - self.interface.data(HEIGHT as u8)?; - self.interface.data((HEIGHT >> 8) as u8)?; - self.interface.data(0x00)?; + self.interface.cmd_with_data(Command::DRIVER_OUTPUT_CONTROL, &[0x27, 0x01, 0x00])?; // 3 Databytes: (and default values from datasheet and arduino) // 1 .. A[6:0] = 0xCF | 0xD7 // 1 .. B[6:0] = 0xCE | 0xD6 // 1 .. C[6:0] = 0x8D | 0x9D //TODO: test - self.interface.command(Command::BOOSTER_SOFT_START_CONTROL)?; - self.interface.data(0xD7)?; - self.interface.data(0xD6)?; - self.interface.data(0x9D)?; + self.interface.cmd_with_data(Command::BOOSTER_SOFT_START_CONTROL, &[0xD7, 0xD6, 0x9D])?; // One Databyte with value 0xA8 for 7V VCOM - self.interface.command(Command::WRITE_VCOM_REGISTER)?; - self.interface.data(0xA8)?; + self.interface.cmd_with_data(Command::WRITE_VCOM_REGISTER, &[0xA8])?; // One Databyte with default value 0x1A for 4 dummy lines per gate - self.interface.command(Command::SET_DUMMY_LINE_PERIOD)?; - self.interface.data(0x1A)?; + self.interface.cmd_with_data(Command::SET_DUMMY_LINE_PERIOD, &[0x1A])?; // One Databyte with default value 0x08 for 2us per line - self.interface.command(Command::SET_GATE_LINE_WIDTH)?; - self.interface.data(0x08)?; + self.interface.cmd_with_data(Command::SET_GATE_LINE_WIDTH, &[0x08])?; // One Databyte with default value 0x03 // -> address: x increment, y increment, address counter is updated in x direction - self.interface.command(Command::DATA_ENTRY_MODE_SETTING)?; - self.interface.data(0x03)?; + self.interface.cmd_with_data(Command::DATA_ENTRY_MODE_SETTING, &[0x03])?; self.set_lut() } - - } impl @@ -141,7 +129,7 @@ where fn sleep(&mut self) -> Result<(), ERR> { // 0x00 for Normal mode (Power on Reset), 0x01 for Deep Sleep Mode //TODO: is 0x00 needed here? (see also epd1in54) - self.interface.command_with_data(Command::DEEP_SLEEP_MODE, &[0x00])?; + self.interface.cmd_with_data(Command::DEEP_SLEEP_MODE, &[0x00])?; self.wait_until_idle(); Ok(()) @@ -158,7 +146,7 @@ where fn update_frame(&mut self, buffer: &[u8]) -> Result<(), ERR> { self.use_full_frame()?; - self.interface.command_with_data(Command::WRITE_RAM, buffer) + self.interface.cmd_with_data(Command::WRITE_RAM, buffer) } //TODO: update description: last 3 bits will be ignored for width and x_pos @@ -173,18 +161,18 @@ where self.set_ram_area(x, y, x + width, y + height)?; self.set_ram_counter(x, y)?; - self.interface.command_with_data(Command::WRITE_RAM, buffer) + self.interface.cmd_with_data(Command::WRITE_RAM, buffer) } fn display_frame(&mut self) -> Result<(), ERR> { // enable clock signal, enable cp, display pattern -> 0xC4 (tested with the arduino version) //TODO: test control_1 or control_2 with default value 0xFF (from the datasheet) - self.interface.command_with_data(Command::DISPLAY_UPDATE_CONTROL_2, &[0xC4])?; + self.interface.cmd_with_data(Command::DISPLAY_UPDATE_CONTROL_2, &[0xC4])?; - self.interface.command(Command::MASTER_ACTIVATION)?; + self.interface.cmd(Command::MASTER_ACTIVATION)?; // MASTER Activation should not be interupted to avoid currption of panel images // therefore a terminate command is send - self.interface.command(Command::NOP) + self.interface.cmd(Command::NOP) } fn clear_frame(&mut self) -> Result<(), ERR> { @@ -193,7 +181,7 @@ where // clear the ram with the background color let color = self.background_color.get_byte_value(); - self.interface.command(Command::WRITE_RAM)?; + self.interface.cmd(Command::WRITE_RAM)?; self.interface.data_x_times(color, WIDTH / 8 * HEIGHT) } @@ -240,27 +228,24 @@ where // x is positioned in bytes, so the last 3 bits which show the position inside a byte in the ram // aren't relevant - self.interface.command(Command::SET_RAM_X_ADDRESS_START_END_POSITION)?; - self.interface.data((start_x >> 3) as u8)?; - self.interface.data((end_x >> 3) as u8)?; + self.interface.cmd_with_data( + Command::SET_RAM_X_ADDRESS_START_END_POSITION, + &[(start_x >> 3) as u8, (end_x >> 3) as u8] + )?; // 2 Databytes: A[7:0] & 0..A[8] for each - start and end - self.interface.command(Command::SET_RAM_Y_ADDRESS_START_END_POSITION)?; - self.interface.data(start_y as u8)?; - self.interface.data((start_y >> 8) as u8)?; - self.interface.data(end_y as u8)?; - self.interface.data((end_y >> 8) as u8) + self.interface.cmd_with_data(Command::SET_RAM_Y_ADDRESS_START_END_POSITION, + &[start_y as u8, (start_y >> 8) as u8, end_y as u8, (end_y >> 8) as u8] + ) } pub(crate) fn set_ram_counter(&mut self, x: u16, y: u16) -> Result<(), E> { // x is positioned in bytes, so the last 3 bits which show the position inside a byte in the ram // aren't relevant - self.interface.command_with_data(Command::SET_RAM_X_ADDRESS_COUNTER, &[(x >> 3) as u8])?; + self.interface.cmd_with_data(Command::SET_RAM_X_ADDRESS_COUNTER, &[(x >> 3) as u8])?; // 2 Databytes: A[7:0] & 0..A[8] - self.interface.command(Command::SET_RAM_Y_ADDRESS_COUNTER)?; - self.interface.data(y as u8)?; - self.interface.data((y >> 8) as u8)?; + self.interface.cmd_with_data(Command::SET_RAM_Y_ADDRESS_COUNTER, &[y as u8, (y >> 8) as u8])?; self.wait_until_idle(); Ok(()) @@ -283,7 +268,7 @@ where fn set_lut_helper(&mut self, buffer: &[u8]) -> Result<(), E> { assert!(buffer.len() == 30); - self.interface.command_with_data(Command::WRITE_LUT_REGISTER, buffer) + self.interface.cmd_with_data(Command::WRITE_LUT_REGISTER, buffer) } } diff --git a/src/epd4in2/command.rs b/src/epd4in2/command.rs index 75800cf..80c016b 100644 --- a/src/epd4in2/command.rs +++ b/src/epd4in2/command.rs @@ -12,8 +12,18 @@ use interface; #[derive(Copy, Clone)] pub(crate) enum Command { /// Set Resolution, LUT selection, BWR pixels, gate scan direction, source shift direction, booster switch, soft reset + /// One Byte of Data: + /// 0x0F Red Mode, LUT from OTP + /// 0x1F B/W Mode, LUT from OTP + /// 0x2F Red Mode, LUT set by registers + /// 0x3F B/W Mode, LUT set by registers PANEL_SETTING = 0x00, /// selecting internal and external power + /// self.send_data(0x03)?; //VDS_EN, VDG_EN + /// self.send_data(0x00)?; //VCOM_HV, VGHL_LV[1], VGHL_LV[0] + /// self.send_data(0x2b)?; //VDH + /// self.send_data(0x2b)?; //VDL + /// self.send_data(0xff)?; //VDHR POWER_SETTING = 0x01, /// After the Power Off command, the driver will power off following the Power Off Sequence. This command will turn off charge /// pump, T-con, source driver, gate driver, VCOM, and temperature sensor, but register data will be kept until VDD becomes OFF. @@ -26,6 +36,7 @@ pub(crate) enum Command { /// This command enables the internal bandgap, which will be cleared by the next POF. POWER_ON_MEASURE = 0x05, /// Starting data transmission + /// 3-times: self.send_data(0x17)?; //07 0f 17 1f 27 2F 37 2f BOOSTER_SOFT_START = 0x06, /// After this command is transmitted, the chip would enter the deep-sleep mode to save power. /// diff --git a/src/epd4in2/mod.rs b/src/epd4in2/mod.rs index 81ca731..8d84d14 100644 --- a/src/epd4in2/mod.rs +++ b/src/epd4in2/mod.rs @@ -90,43 +90,24 @@ where self.interface.reset(); // set the power settings - self.command(Command::POWER_SETTING)?; - self.send_data(0x03)?; //VDS_EN, VDG_EN - self.send_data(0x00)?; //VCOM_HV, VGHL_LV[1], VGHL_LV[0] - self.send_data(0x2b)?; //VDH - self.send_data(0x2b)?; //VDL - self.send_data(0xff)?; //VDHR + self.interface.cmd_with_data(Command::POWER_SETTING, &[0x03, 0x00, 0x2b, 0x2b, 0xff])?; // start the booster - self.command(Command::BOOSTER_SOFT_START)?; - for _ in 0..3 { - self.send_data(0x17)?; //07 0f 17 1f 27 2F 37 2f - } + self.interface.cmd_with_data(Command::BOOSTER_SOFT_START, &[0x17, 0x17, 0x17])?; // power on self.command(Command::POWER_ON)?; self.wait_until_idle(); // set the panel settings - self.command(Command::PANEL_SETTING)?; - // 0x0F Red Mode, LUT from OTP - // 0x1F B/W Mode, LUT from OTP - // 0x2F Red Mode, LUT set by registers - // 0x3F B/W Mode, LUT set by registers - self.send_data(0x3F)?; - - // the values used by waveshare before for the panel settings - // instead of our one liner: - // SendData(0xbf); // KW-BF KWR-AF BWROTP 0f - // SendData(0x0b); + self.cmd_with_data(Command::PANEL_SETTING, &[0x3F])?; // Set Frequency, 200 Hz didn't work on my board // 150Hz and 171Hz wasn't tested yet // TODO: Test these other frequencies // 3A 100HZ 29 150Hz 39 200HZ 31 171HZ DEFAULT: 3c 50Hz - self.command(Command::PLL_CONTROL)?; - self.send_data(0x3A)?; - + self.cmd_with_data(Command::PLL_CONTROL, &[0x3A])?; + self.set_lut()?; Ok(()) @@ -179,20 +160,20 @@ where //TODO: is such a long delay really needed inbetween? fn sleep(&mut self) -> Result<(), ERR> { - self.interface.command_with_data(Command::VCOM_AND_DATA_INTERVAL_SETTING, &[0x17])?; //border floating + self.interface.cmd_with_data(Command::VCOM_AND_DATA_INTERVAL_SETTING, &[0x17])?; //border floating self.command(Command::VCM_DC_SETTING)?; // VCOM to 0V self.command(Command::PANEL_SETTING)?; self.delay_ms(100); self.command(Command::POWER_SETTING)?; //VG&VS to 0V fast for _ in 0..4 { - self.send_data(0x00)?; + self.send_data(&[0x00])?; } self.delay_ms(100); self.command(Command::POWER_OFF)?; self.wait_until_idle(); - self.interface.command_with_data(Command::DEEP_SLEEP, &[0xA5]) + self.interface.cmd_with_data(Command::DEEP_SLEEP, &[0xA5]) } fn update_frame(&mut self, buffer: &[u8]) -> Result<(), ERR> { @@ -200,11 +181,11 @@ where self.send_resolution()?; - self.interface.command_with_data(Command::VCM_DC_SETTING, &[0x12])?; + self.interface.cmd_with_data(Command::VCM_DC_SETTING, &[0x12])?; //TODO: this was a send_command instead of a send_data. check if it's alright and doing what it should do (setting the default values) //self.send_command_u8(0x97)?; //VBDF 17|D7 VBDW 97 VBDB 57 VBDF F7 VBDW 77 VBDB 37 VBDR B7 - self.interface.command_with_data(Command::VCOM_AND_DATA_INTERVAL_SETTING, &[0x97])?; + self.interface.cmd_with_data(Command::VCOM_AND_DATA_INTERVAL_SETTING, &[0x97])?; self.command(Command::DATA_START_TRANSMISSION_1)?; @@ -212,7 +193,7 @@ where self.delay_ms(2); - self.interface.command_with_data(Command::DATA_START_TRANSMISSION_2, buffer) + self.interface.cmd_with_data(Command::DATA_START_TRANSMISSION_2, buffer) } fn update_partial_frame( @@ -230,20 +211,20 @@ where self.command(Command::PARTIAL_IN)?; self.command(Command::PARTIAL_WINDOW)?; - self.send_data((x >> 8) as u8)?; + self.send_data(&[(x >> 8) as u8])?; let tmp = x & 0xf8; - self.send_data(tmp as u8)?; // x should be the multiple of 8, the last 3 bit will always be ignored + self.send_data(&[tmp as u8])?; // x should be the multiple of 8, the last 3 bit will always be ignored let tmp = tmp + width - 1; - self.send_data((tmp >> 8) as u8)?; - self.send_data((tmp | 0x07) as u8)?; + self.send_data(&[(tmp >> 8) as u8])?; + self.send_data(&[(tmp | 0x07) as u8])?; - self.send_data((y >> 8) as u8)?; - self.send_data(y as u8)?; + self.send_data(&[(y >> 8) as u8])?; + self.send_data(&[y as u8])?; - self.send_data(((y + height - 1) >> 8) as u8)?; - self.send_data((y + height - 1) as u8)?; + self.send_data(&[((y + height - 1) >> 8) as u8])?; + self.send_data(&[(y + height - 1) as u8])?; - self.send_data(0x01)?; // Gates scan both inside and outside of the partial window. (default) + self.send_data(&[0x01])?; // Gates scan both inside and outside of the partial window. (default) //TODO: handle dtm somehow let is_dtm1 = false; @@ -253,7 +234,7 @@ where self.command(Command::DATA_START_TRANSMISSION_2)? } - self.send_multiple_data(buffer)?; + self.send_data(buffer)?; self.command(Command::PARTIAL_OUT) } @@ -315,15 +296,15 @@ where D: DelayUs + DelayMs, { fn command(&mut self, command: Command) -> Result<(), ERR> { - self.interface.command(command) + self.interface.cmd(command) } - fn send_data(&mut self, val: u8) -> Result<(), ERR> { - self.interface.data(val) + fn send_data(&mut self, data: &[u8]) -> Result<(), ERR> { + self.interface.data(data) } - fn send_multiple_data(&mut self, data: &[u8]) -> Result<(), ERR> { - self.interface.multiple_data(data) + fn cmd_with_data(&mut self, command: Command, data: &[u8]) -> Result<(), ERR> { + self.interface.cmd_with_data(command, data) } fn wait_until_idle(&mut self) { @@ -335,10 +316,10 @@ where let h = self.height(); self.command(Command::RESOLUTION_SETTING)?; - self.send_data((w >> 8) as u8)?; - self.send_data(w as u8)?; - self.send_data((h >> 8) as u8)?; - self.send_data(h as u8) + self.send_data(&[(w >> 8) as u8])?; + self.send_data(&[w as u8])?; + self.send_data(&[(h >> 8) as u8])?; + self.send_data(&[h as u8]) } /// Fill the look-up table for the EPD @@ -372,23 +353,23 @@ where ) -> Result<(), ERR> { // LUT VCOM self.command(Command::LUT_FOR_VCOM)?; - self.send_multiple_data(lut_vcom)?; + self.send_data(lut_vcom)?; // LUT WHITE to WHITE self.command(Command::LUT_WHITE_TO_WHITE)?; - self.send_multiple_data(lut_ww)?; + self.send_data(lut_ww)?; // LUT BLACK to WHITE self.command(Command::LUT_BLACK_TO_WHITE)?; - self.send_multiple_data(lut_bw)?; + self.send_data(lut_bw)?; // LUT WHITE to BLACK self.command(Command::LUT_WHITE_TO_BLACK)?; - self.send_multiple_data(lut_wb)?; + self.send_data(lut_wb)?; // LUT BLACK to BLACK self.command(Command::LUT_BLACK_TO_BLACK)?; - self.send_multiple_data(lut_bb)?; + self.send_data(lut_bb)?; Ok(()) } diff --git a/src/interface/connection_interface.rs b/src/interface/connection_interface.rs index f825807..d55750e 100644 --- a/src/interface/connection_interface.rs +++ b/src/interface/connection_interface.rs @@ -48,7 +48,7 @@ where /// Enables direct interaction with the device with the help of [data()](ConnectionInterface::data()) /// /// //TODO: make public? - pub(crate) fn command(&mut self, command: T) -> Result<(), ERR> { + pub(crate) fn cmd(&mut self, command: T) -> Result<(), ERR> { // low for commands self.dc.set_low(); @@ -56,25 +56,25 @@ where self.with_cs(|epd| epd.spi.write(&[command.address()])) } - /// Basic function for sending a single u8 of data over spi + /// Basic function for sending an array of u8-values of data over spi /// - /// Enables direct interaction with the device with the help of [Ecommand()](ConnectionInterface::command()) + /// Enables direct interaction with the device with the help of [command()](EPD4in2::command()) /// /// //TODO: make public? - pub(crate) fn data(&mut self, val: u8) -> Result<(), ERR> { + pub(crate) fn data(&mut self, data: &[u8]) -> Result<(), ERR> { // high for data self.dc.set_high(); - // Transfer data (u8) over spi - self.with_cs(|epd| epd.spi.write(&[val])) + // Transfer data (u8-array) over spi + self.with_cs(|epd| epd.spi.write(data)) } /// Basic function for sending [Commands](Command) and the data belonging to it. /// /// //TODO: make public? - pub(crate) fn command_with_data(&mut self, command: T, data: &[u8]) -> Result<(), ERR> { - self.command(command)?; - self.multiple_data(data) + pub(crate) fn cmd_with_data(&mut self, command: T, data: &[u8]) -> Result<(), ERR> { + self.cmd(command)?; + self.data(data) } /// Basic function for sending the same byte of data (one u8) multiple times over spi @@ -99,18 +99,7 @@ where }) } - /// Basic function for sending an array of u8-values of data over spi - /// - /// Enables direct interaction with the device with the help of [command()](EPD4in2::command()) - /// - /// //TODO: make public? - pub(crate) fn multiple_data(&mut self, data: &[u8]) -> Result<(), ERR> { - // high for data - self.dc.set_high(); - // Transfer data (u8-array) over spi - self.with_cs(|epd| epd.spi.write(data)) - } // spi write helper/abstraction function fn with_cs(&mut self, f: F) -> Result<(), ERR> From 6efa8640146625466dec184efebb3f197f955b01 Mon Sep 17 00:00:00 2001 From: Chris Date: Wed, 10 Oct 2018 11:37:36 +0200 Subject: [PATCH 2/4] Renamed folder `interface` to `traits` --- src/epd1in54/mod.rs | 4 ++-- src/epd2in9/mod.rs | 4 ++-- src/epd4in2/command.rs | 6 +++--- src/epd4in2/mod.rs | 2 +- src/lib.rs | 4 ++-- src/{interface => traits}/connection_interface.rs | 2 +- src/{interface => traits}/mod.rs | 0 src/type_a/command.rs | 6 +++--- 8 files changed, 14 insertions(+), 14 deletions(-) rename src/{interface => traits}/connection_interface.rs (99%) rename src/{interface => traits}/mod.rs (100%) diff --git a/src/epd1in54/mod.rs b/src/epd1in54/mod.rs index 93de08e..f90a814 100644 --- a/src/epd1in54/mod.rs +++ b/src/epd1in54/mod.rs @@ -33,9 +33,9 @@ use type_a::{command::Command, LUT_FULL_UPDATE, LUT_PARTIAL_UPDATE}; use color::Color; -use interface::{WaveshareInterface}; +use traits::{WaveshareInterface}; -use interface::connection_interface::ConnectionInterface; +use traits::connection_interface::ConnectionInterface; /// EPD1in54 driver /// diff --git a/src/epd2in9/mod.rs b/src/epd2in9/mod.rs index 5a86d83..5b8145e 100644 --- a/src/epd2in9/mod.rs +++ b/src/epd2in9/mod.rs @@ -32,9 +32,9 @@ use type_a::{command::Command, LUT_FULL_UPDATE, LUT_PARTIAL_UPDATE}; use color::Color; -use interface::*; +use traits::*; -use interface::connection_interface::ConnectionInterface; +use traits::connection_interface::ConnectionInterface; /// EPD2in9 driver /// diff --git a/src/epd4in2/command.rs b/src/epd4in2/command.rs index 80c016b..60173e8 100644 --- a/src/epd4in2/command.rs +++ b/src/epd4in2/command.rs @@ -1,5 +1,5 @@ //! SPI Commands for the Waveshare 4.2" E-Ink Display -use interface; +use traits; /// EPD4IN2 commands /// /// Should rarely (never?) be needed directly. @@ -155,7 +155,7 @@ pub(crate) enum Command { POWER_SAVING = 0xE3, } -impl interface::Command for Command { +impl traits::Command for Command { /// Returns the address of the command fn address(self) -> u8 { self as u8 @@ -165,7 +165,7 @@ impl interface::Command for Command { #[cfg(test)] mod tests { use super::*; - use interface::Command as CommandTrait; + use traits::Command as CommandTrait; #[test] fn command_addr() { diff --git a/src/epd4in2/mod.rs b/src/epd4in2/mod.rs index 8d84d14..9ab5ab5 100644 --- a/src/epd4in2/mod.rs +++ b/src/epd4in2/mod.rs @@ -51,7 +51,7 @@ use hal::{ digital::*, }; -use interface::{connection_interface::ConnectionInterface, WaveshareInterface, InternalWiAdditions}; +use traits::{connection_interface::ConnectionInterface, WaveshareInterface, InternalWiAdditions}; //The Lookup Tables for the Display mod constants; diff --git a/src/lib.rs b/src/lib.rs index 42ceaf3..5e34505 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -50,8 +50,8 @@ use hal::spi::{Mode, Phase, Polarity}; #[cfg(feature = "graphics")] pub mod drawing; -mod interface; -pub use interface::{WaveshareInterface}; +mod traits; +pub use traits::{WaveshareInterface}; pub mod color; diff --git a/src/interface/connection_interface.rs b/src/traits/connection_interface.rs similarity index 99% rename from src/interface/connection_interface.rs rename to src/traits/connection_interface.rs index d55750e..842adb0 100644 --- a/src/interface/connection_interface.rs +++ b/src/traits/connection_interface.rs @@ -3,7 +3,7 @@ use hal::{ digital::*, }; -use interface::Command; +use traits::Command; /// The Connection Interface of all (?) Waveshare EPD-Devices /// diff --git a/src/interface/mod.rs b/src/traits/mod.rs similarity index 100% rename from src/interface/mod.rs rename to src/traits/mod.rs diff --git a/src/type_a/command.rs b/src/type_a/command.rs index 5272c07..36d6027 100644 --- a/src/type_a/command.rs +++ b/src/type_a/command.rs @@ -1,6 +1,6 @@ //! SPI Commands for the Waveshare 2.9" and 1.54" E-Ink Display -use interface; +use traits; /// EPD1in54 and EPD2IN9 commands /// @@ -71,7 +71,7 @@ pub(crate) enum Command { NOP = 0xFF, } -impl interface::Command for Command { +impl traits::Command for Command { /// Returns the address of the command fn address(self) -> u8 { self as u8 @@ -81,7 +81,7 @@ impl interface::Command for Command { #[cfg(test)] mod tests { use super::Command; - use interface::Command as CommandTrait; + use traits::Command as CommandTrait; #[test] fn command_addr() { From 38dc5126eedc480422c2d131bc43efef8b101909 Mon Sep 17 00:00:00 2001 From: Chris Date: Wed, 10 Oct 2018 13:23:43 +0200 Subject: [PATCH 3/4] Make delay a function parameter This change makes delay a function parameter where necessary and stops the need of owning the delay --- src/epd1in54/mod.rs | 36 +++++++++----------- src/epd2in9/mod.rs | 37 +++++++++------------ src/epd4in2/mod.rs | 53 +++++++++++++++--------------- src/traits/connection_interface.rs | 36 +++++++------------- src/traits/mod.rs | 17 +++------- 5 files changed, 73 insertions(+), 106 deletions(-) diff --git a/src/epd1in54/mod.rs b/src/epd1in54/mod.rs index f90a814..5d0c7f1 100644 --- a/src/epd1in54/mod.rs +++ b/src/epd1in54/mod.rs @@ -39,26 +39,25 @@ use traits::connection_interface::ConnectionInterface; /// EPD1in54 driver /// -pub struct EPD1in54 { +pub struct EPD1in54 { /// SPI - interface: ConnectionInterface, + interface: ConnectionInterface, /// EPD (width, height) //epd: EPD, /// Color background_color: Color, } -impl EPD1in54 +impl EPD1in54 where SPI: Write, CS: OutputPin, BUSY: InputPin, DC: OutputPin, RST: OutputPin, - Delay: DelayUs + DelayMs, { - fn init(&mut self) -> Result<(), E> { - self.interface.reset(); + fn init>(&mut self, delay: &mut DELAY) -> Result<(), E> { + self.interface.reset(delay); // 3 Databytes: // A[7:0] @@ -95,8 +94,8 @@ where } -impl WaveshareInterface - for EPD1in54 +impl WaveshareInterface + for EPD1in54 where SPI: Write, CS: OutputPin, @@ -113,23 +112,23 @@ where HEIGHT } - fn new( - spi: SPI, cs: CS, busy: BUSY, dc: DC, rst: RST, delay: Delay, + fn new>( + spi: SPI, cs: CS, busy: BUSY, dc: DC, rst: RST, delay: &mut DELAY, ) -> Result { - let interface = ConnectionInterface::new(spi, cs, busy, dc, rst, delay); + let interface = ConnectionInterface::new(spi, cs, busy, dc, rst); let mut epd = EPD1in54 { interface, background_color: DEFAULT_BACKGROUND_COLOR, }; - epd.init()?; + epd.init(delay)?; Ok(epd) } - fn wake_up(&mut self) -> Result<(), E> { - self.init() + fn wake_up>(&mut self, delay: &mut DELAY) -> Result<(), E> { + self.init(delay) } @@ -143,10 +142,6 @@ where Ok(()) } - fn delay_ms(&mut self, delay: u16) { - self.interface.delay_ms(delay) - } - fn update_frame(&mut self, buffer: &[u8]) -> Result<(), E> { self.use_full_frame()?; self.interface.cmd_with_data(Command::WRITE_RAM, buffer) @@ -199,14 +194,13 @@ where } } -impl EPD1in54 +impl EPD1in54 where SPI: Write, CS: OutputPin, BUSY: InputPin, DC: OutputPin, - RST: OutputPin, - D: DelayUs + DelayMs, + RST: OutputPin { fn wait_until_idle(&mut self) { self.interface.wait_until_idle(false); diff --git a/src/epd2in9/mod.rs b/src/epd2in9/mod.rs index 5b8145e..db6fa03 100644 --- a/src/epd2in9/mod.rs +++ b/src/epd2in9/mod.rs @@ -38,26 +38,25 @@ use traits::connection_interface::ConnectionInterface; /// EPD2in9 driver /// -pub struct EPD2in9 { +pub struct EPD2in9 { /// SPI - interface: ConnectionInterface, + interface: ConnectionInterface, /// EPD (width, height) //epd: EPD, /// Color background_color: Color, } -impl EPD2in9 +impl EPD2in9 where SPI: Write, CS: OutputPin, BUSY: InputPin, DC: OutputPin, RST: OutputPin, - Delay: DelayUs + DelayMs, { - fn init(&mut self) -> Result<(), E> { - self.interface.reset(); + fn init>(&mut self, delay: &mut DELAY) -> Result<(), E> { + self.interface.reset(delay); // 3 Databytes: // A[7:0] @@ -90,16 +89,15 @@ where } } -impl - WaveshareInterface - for EPD2in9 +impl + WaveshareInterface + for EPD2in9 where SPI: Write, CS: OutputPin, BUSY: InputPin, DC: OutputPin, RST: OutputPin, - Delay: DelayUs + DelayMs, { fn width(&self) -> u16 { WIDTH @@ -109,17 +107,17 @@ where HEIGHT } - fn new( - spi: SPI, cs: CS, busy: BUSY, dc: DC, rst: RST, delay: Delay, + fn new>( + spi: SPI, cs: CS, busy: BUSY, dc: DC, rst: RST, delay: &mut DELAY, ) -> Result { - let interface = ConnectionInterface::new(spi, cs, busy, dc, rst, delay); + let interface = ConnectionInterface::new(spi, cs, busy, dc, rst); let mut epd = EPD2in9 { interface, background_color: DEFAULT_BACKGROUND_COLOR, }; - epd.init()?; + epd.init(delay)?; Ok(epd) } @@ -135,12 +133,8 @@ where Ok(()) } - fn wake_up(&mut self) -> Result<(), ERR> { - self.init() - } - - fn delay_ms(&mut self, delay: u16) { - self.interface.delay_ms(delay) + fn wake_up>(&mut self, delay: &mut DELAY) -> Result<(), ERR> { + self.init(delay) } fn update_frame(&mut self, buffer: &[u8]) -> Result<(), ERR> { @@ -195,14 +189,13 @@ where } } -impl EPD2in9 +impl EPD2in9 where SPI: Write, CS: OutputPin, BUSY: InputPin, DC: OutputPin, RST: OutputPin, - D: DelayUs + DelayMs, { fn wait_until_idle(&mut self) { self.interface.wait_until_idle(false); diff --git a/src/epd4in2/mod.rs b/src/epd4in2/mod.rs index 9ab5ab5..3905f99 100644 --- a/src/epd4in2/mod.rs +++ b/src/epd4in2/mod.rs @@ -64,9 +64,9 @@ use self::command::Command; /// EPD4in2 driver /// -pub struct EPD4in2 { +pub struct EPD4in2 { /// Connection Interface - interface: ConnectionInterface, + interface: ConnectionInterface, /// Background Color color: Color, } @@ -74,20 +74,19 @@ pub struct EPD4in2 { -impl - InternalWiAdditions - for EPD4in2 +impl + InternalWiAdditions + for EPD4in2 where SPI: Write, CS: OutputPin, BUSY: InputPin, DC: OutputPin, RST: OutputPin, - Delay: DelayUs + DelayMs, { - fn init(&mut self) -> Result<(), ERR> { + fn init>(&mut self, delay: &mut DELAY) -> Result<(), ERR> { // reset the device - self.interface.reset(); + self.interface.reset(delay); // set the power settings self.interface.cmd_with_data(Command::POWER_SETTING, &[0x03, 0x00, 0x2b, 0x2b, 0xff])?; @@ -114,16 +113,15 @@ where } } -impl - WaveshareInterface - for EPD4in2 +impl + WaveshareInterface + for EPD4in2 where SPI: Write, CS: OutputPin, BUSY: InputPin, DC: OutputPin, RST: OutputPin, - Delay: DelayUs + DelayMs, { /// Creates a new driver from a SPI peripheral, CS Pin, Busy InputPin, DC /// @@ -140,8 +138,8 @@ where /// /// epd4in2.sleep(); /// ``` - fn new(spi: SPI, cs: CS, busy: BUSY, dc: DC, rst: RST, delay: Delay) -> Result { - let interface = ConnectionInterface::new(spi, cs, busy, dc, rst, delay); + fn new>(spi: SPI, cs: CS, busy: BUSY, dc: DC, rst: RST, delay: &mut DELAY) -> Result { + let interface = ConnectionInterface::new(spi, cs, busy, dc, rst); let color = DEFAULT_BACKGROUND_COLOR; let mut epd = EPD4in2 { @@ -149,13 +147,13 @@ where color, }; - epd.init()?; + epd.init(delay)?; Ok(epd) } - fn wake_up(&mut self) -> Result<(), ERR> { - self.init() + fn wake_up>(&mut self, delay: &mut DELAY) -> Result<(), ERR> { + self.init(delay) } //TODO: is such a long delay really needed inbetween? @@ -163,13 +161,17 @@ where self.interface.cmd_with_data(Command::VCOM_AND_DATA_INTERVAL_SETTING, &[0x17])?; //border floating self.command(Command::VCM_DC_SETTING)?; // VCOM to 0V self.command(Command::PANEL_SETTING)?; - self.delay_ms(100); + + //TODO: Removal of delay. TEST! + //self.delay_ms(100); self.command(Command::POWER_SETTING)?; //VG&VS to 0V fast for _ in 0..4 { self.send_data(&[0x00])?; } - self.delay_ms(100); + + //TODO: Removal of delay. TEST! + //self.delay_ms(100); self.command(Command::POWER_OFF)?; self.wait_until_idle(); @@ -191,7 +193,8 @@ where self.command(Command::DATA_START_TRANSMISSION_1)?; self.interface.data_x_times(color_value, buffer.len() as u16)?; - self.delay_ms(2); + //TODO: Removal of delay. TEST! + //self.delay_ms(2); self.interface.cmd_with_data(Command::DATA_START_TRANSMISSION_2, buffer) } @@ -257,7 +260,8 @@ where self.command(Command::DATA_START_TRANSMISSION_1)?; self.interface.data_x_times(color_value, size)?; - self.delay_ms(2); + //TODO: Removal of delay. TEST! + //self.delay_ms(2); self.command(Command::DATA_START_TRANSMISSION_2)?; self.interface.data_x_times(color_value, size) @@ -279,14 +283,9 @@ where fn height(&self) -> u16 { HEIGHT } - - - fn delay_ms(&mut self, delay: u16) { - self.interface.delay_ms(delay) - } } -impl EPD4in2 +impl EPD4in2 where SPI: Write, CS: OutputPin, diff --git a/src/traits/connection_interface.rs b/src/traits/connection_interface.rs index 842adb0..978ba2e 100644 --- a/src/traits/connection_interface.rs +++ b/src/traits/connection_interface.rs @@ -7,7 +7,7 @@ use traits::Command; /// The Connection Interface of all (?) Waveshare EPD-Devices /// -pub(crate) struct ConnectionInterface { +pub(crate) struct ConnectionInterface { /// SPI spi: SPI, /// CS for SPI @@ -18,28 +18,24 @@ pub(crate) struct ConnectionInterface { dc: DC, /// Pin for Reseting rst: RST, - /// The concrete Delay implementation - delay: D, } -impl - ConnectionInterface +impl + ConnectionInterface where SPI: Write, CS: OutputPin, BUSY: InputPin, DC: OutputPin, RST: OutputPin, - Delay: DelayUs + DelayMs, { - pub fn new(spi: SPI, cs: CS, busy: BUSY, dc: DC, rst: RST, delay: Delay) -> Self { + pub fn new(spi: SPI, cs: CS, busy: BUSY, dc: DC, rst: RST) -> Self { ConnectionInterface { spi, cs, busy, dc, rst, - delay, } } @@ -130,35 +126,27 @@ where /// Most likely there was a mistake with the 2in9 busy connection /// //TODO: use the #cfg feature to make this compile the right way for the certain types pub(crate) fn wait_until_idle(&mut self, is_busy_low: bool) { - self.delay_ms(1); + // TODO: removal of delay. TEST! + //self.delay_ms(1); //low: busy, high: idle while (is_busy_low && self.busy.is_low()) || (!is_busy_low && self.busy.is_high()) { - //TODO: shorten the time? it was 100 in the beginning - self.delay_ms(5); + //TODO: REMOVAL of DELAY: it's only waiting for the signal anyway and should continue work asap + //old: shorten the time? it was 100 in the beginning + //self.delay_ms(5); } } - /// Abstraction of setting the delay for simpler calls - /// - /// maximum delay ~65 seconds (u16:max in ms) - pub(crate) fn delay_ms(&mut self, delay: u16) { - self.delay.delay_ms(delay); - } - /// Resets the device. /// /// Often used to awake the module from deep sleep. See [EPD4in2::sleep()](EPD4in2::sleep()) /// /// TODO: Takes at least 400ms of delay alone, can it be shortened? - pub(crate) fn reset(&mut self) { + pub(crate) fn reset>(&mut self, delay: &mut DELAY) { self.rst.set_low(); - //TODO: why 200ms? (besides being in the arduino version) - self.delay_ms(200); - + delay.delay_ms(200); self.rst.set_high(); - //TODO: same as 3 lines above - self.delay_ms(200); + delay.delay_ms(200); } } diff --git a/src/traits/mod.rs b/src/traits/mod.rs index dc8bbb6..c6f58ea 100644 --- a/src/traits/mod.rs +++ b/src/traits/mod.rs @@ -26,14 +26,13 @@ trait LUTSupport { } -pub(crate) trait InternalWiAdditions +pub(crate) trait InternalWiAdditions where SPI: Write, CS: OutputPin, BUSY: InputPin, DC: OutputPin, RST: OutputPin, - Delay: DelayUs + DelayMs, { /// This initialises the EPD and powers it up /// @@ -45,26 +44,25 @@ where /// This function calls [reset()](WaveshareInterface::reset()), /// so you don't need to call reset your self when trying to wake your device up /// after setting it to sleep. - fn init(&mut self) -> Result<(), ERR>; + fn init>(&mut self, delay: &mut DELAY) -> Result<(), ERR>; } -pub trait WaveshareInterface +pub trait WaveshareInterface where SPI: Write, CS: OutputPin, BUSY: InputPin, DC: OutputPin, RST: OutputPin, - Delay: DelayUs + DelayMs, { /// Creates a new driver from a SPI peripheral, CS Pin, Busy InputPin, DC /// /// This already initialises the device. That means [init()](WaveshareInterface::init()) isn't needed directly afterwards - fn new( - spi: SPI, cs: CS, busy: BUSY, dc: DC, rst: RST, delay: Delay, + fn new>( + spi: SPI, cs: CS, busy: BUSY, dc: DC, rst: RST, delay: DELAY, ) -> Result where Self: Sized; @@ -92,11 +90,6 @@ where /// Get the height of the display fn height(&self) -> u16; - /// Abstraction of setting the delay for simpler calls - /// - /// maximum delay ~65 seconds (u16:max in ms) - fn delay_ms(&mut self, delay: u16); - /// Transmit a full frame to the SRAM of the EPD fn update_frame(&mut self, buffer: &[u8]) -> Result<(), ERR>; From 829a9e71eb77ba33e94d138e30f183e914a582d9 Mon Sep 17 00:00:00 2001 From: Chris Date: Wed, 10 Oct 2018 13:30:52 +0200 Subject: [PATCH 4/4] Fix previous Delay Commit Some stuff was forgotten in the previous commit --- src/epd1in54/mod.rs | 3 +-- src/epd2in9/mod.rs | 2 +- src/epd4in2/mod.rs | 3 +-- src/traits/mod.rs | 6 +++--- 4 files changed, 6 insertions(+), 8 deletions(-) diff --git a/src/epd1in54/mod.rs b/src/epd1in54/mod.rs index 5d0c7f1..7b19b7d 100644 --- a/src/epd1in54/mod.rs +++ b/src/epd1in54/mod.rs @@ -94,7 +94,7 @@ where } -impl WaveshareInterface +impl WaveshareInterface for EPD1in54 where SPI: Write, @@ -102,7 +102,6 @@ where BUSY: InputPin, DC: OutputPin, RST: OutputPin, - Delay: DelayUs + DelayMs, { fn width(&self) -> u16 { WIDTH diff --git a/src/epd2in9/mod.rs b/src/epd2in9/mod.rs index db6fa03..7eaeccd 100644 --- a/src/epd2in9/mod.rs +++ b/src/epd2in9/mod.rs @@ -189,7 +189,7 @@ where } } -impl EPD2in9 +impl EPD2in9 where SPI: Write, CS: OutputPin, diff --git a/src/epd4in2/mod.rs b/src/epd4in2/mod.rs index 3905f99..f4bac81 100644 --- a/src/epd4in2/mod.rs +++ b/src/epd4in2/mod.rs @@ -285,14 +285,13 @@ where } } -impl EPD4in2 +impl EPD4in2 where SPI: Write, CS: OutputPin, BUSY: InputPin, DC: OutputPin, RST: OutputPin, - D: DelayUs + DelayMs, { fn command(&mut self, command: Command) -> Result<(), ERR> { self.interface.cmd(command) diff --git a/src/traits/mod.rs b/src/traits/mod.rs index c6f58ea..0ec5c8f 100644 --- a/src/traits/mod.rs +++ b/src/traits/mod.rs @@ -61,8 +61,8 @@ where /// Creates a new driver from a SPI peripheral, CS Pin, Busy InputPin, DC /// /// This already initialises the device. That means [init()](WaveshareInterface::init()) isn't needed directly afterwards - fn new>( - spi: SPI, cs: CS, busy: BUSY, dc: DC, rst: RST, delay: DELAY, + fn new>( + spi: SPI, cs: CS, busy: BUSY, dc: DC, rst: RST, delay: &mut DELAY, ) -> Result where Self: Sized; @@ -75,7 +75,7 @@ where /// and initialising which already contains the reset fn sleep(&mut self) -> Result<(), ERR>; - fn wake_up(&mut self) -> Result<(), ERR>; + fn wake_up>(&mut self, delay: &mut DELAY) -> Result<(), ERR>; /// Sets the backgroundcolor for various commands like [clear_frame()](WaveshareInterface::clear_frame())