Merge pull request #216 from caemor/epd2in7

Epd2in7 by @andrej-mk

src/epd2in7/command.rs

@@ -0,0 +1,138 @@
+//! SPI Commands for the Waveshare 2.7" E-Ink Display
+use crate::traits;
+
+/// EPD2IN7 commands
+///
+/// More information can be found in the [specification](https://www.waveshare.com/w/upload/2/2d/2.7inch-e-paper-Specification.pdf)
+#[allow(dead_code)]
+#[derive(Copy, Clone)]
+pub(crate) enum Command {
+    /// Set Resolution, LUT selection, BWR pixels, gate scan direction, source shift direction, booster switch, soft reset
+    PanelSetting = 0x00,
+    /// Selecting internal and external power
+    PowerSetting = 0x01,
+    PowerOff = 0x02,
+    /// Setting Power OFF sequence
+    PowerOffSequenceSetting = 0x03,
+    PowerOn = 0x04,
+    /// This command enables the internal bandgap, which will be cleared by the next POF.
+    PowerOnMeasure = 0x05,
+    /// Starting data transmission
+    ///
+    /// ```ignore
+    /// self.send_data(&[0x07, 0x07, 0x17])?;
+    /// ```
+    BoosterSoftStart = 0x06,
+    /// After this command is transmitted, the chip would enter the deep-sleep mode to save power.
+    ///
+    /// The deep sleep mode would return to standby by hardware reset.
+    ///
+    /// The only one parameter is a check code, the command would be excuted if check code = 0xA5.
+    DeepSleep = 0x07,
+    /// This command starts transmitting data and write them into SRAM. To complete data transmission, command DSP (Data
+    /// transmission Stop) must be issued. Then the chip will start to send data/VCOM for panel.
+    ///
+    /// - In B/W mode, this command writes “OLD” data to SRAM.
+    /// - In B/W/Red mode, this command writes “B/W” data to SRAM.
+    DataStartTransmission1 = 0x10,
+    /// Stopping data transmission
+    DataStop = 0x11,
+    /// Stopping data transmission
+    /// After this command is issued, driver will refresh display (data/VCOM) according to SRAM data and LUT.
+    DisplayRefresh = 0x12,
+    /// This command starts transmitting data and write them into SRAM. To complete data transmission, command DSP (Data
+    /// transmission Stop) must be issued. Then the chip will start to send data/VCOM for panel.
+    /// - In B/W mode, this command writes “NEW” data to SRAM.
+    /// - In B/W/Red mode, this command writes “RED” data to SRAM.
+    DataStartTransmission2 = 0x13,
+    /// The command define as follows: The register is indicates that user start to transmit data, then write to SRAM. While data transmission
+    /// complete, user must send command DSP (Data transmission Stop). Then chip will start to send data/VCOM for panel.
+    ///
+    /// - In B/W mode, this command writes “OLD” data to SRAM.
+    /// - In B/W/Red mode, this command writes “B/W” data to SRAM.
+    PartialDataStartTransmission1 = 0x14,
+    /// The command define as follows: The register is indicates that user start to transmit data, then write to SRAM. While data transmission
+    /// complete, user must send command DSP (Data transmission Stop). Then chip will start to send data/VCOM for panel.
+    ///
+    /// - In B/W mode, this command writes “NEW” data to SRAM.
+    /// - In B/W/Red mode, this command writes “RED” data to SRAM.
+    PartialDataStartTransmission2 = 0x15,
+    /// While user sent this command, driver will refresh display (data/VCOM) base on SRAM data and LUT.
+    ///
+    /// Only the area (X,Y, W, L) would update, the others pixel output would follow VCOM LUT
+    PartialDisplayRefresh = 0x16,
+    /// This command builds the Look-up table for VCOM
+    LutForVcom = 0x20,
+    LutWhiteToWhite = 0x21,
+    LutBlackToWhite = 0x22,
+    LutWhiteToBlack = 0x23,
+    LutBlackToBlack = 0x24,
+    /// The command controls the PLL clock frequency.
+    PllControl = 0x30,
+    /// This command reads the temperature sensed by the temperature sensor.
+    ///
+    /// Doesn't work! Waveshare doesn't connect the read pin
+    TemperatureSensor = 0x40,
+    /// This command selects Internal or External temperature sensor.
+    TemperatureSensorCalibration = 0x41,
+    /// Write External Temperature Sensor
+    TemperatureSensorWrite = 0x42,
+    /// Read External Temperature Sensor
+    ///
+    /// Doesn't work! Waveshare doesn't connect the read pin
+    TemperatureSensorRead = 0x43,
+    /// This command indicates the interval of Vcom and data output. When setting the vertical back porch, the total blanking will be kept (20 Hsync)
+    VcomAndDataIntervalSetting = 0x50,
+    /// This command indicates the input power condition. Host can read this flag to learn the battery condition.
+    LowPowerDetection = 0x51,
+    /// This command defines non-overlap period of Gate and Source.
+    TconSetting = 0x60,
+    /// This command defines alternative resolution and this setting is of higher priority than the RES\[1:0\] in R00H (PSR).
+    ResolutionSetting = 0x61,
+    SourceAndGateSetting = 0x62,
+    /// This command reads the IC status.
+    ///
+    /// Doesn't work! Waveshare doesn't connect the read pin
+    GetStatus = 0x71,
+    /// Automatically measure VCOM. This command reads the IC status
+    AutoMeasurementVcom = 0x80,
+    /// This command gets the VCOM value
+    ///
+    /// Doesn't work! Waveshare doesn't connect the read pin
+    ReadVcomValue = 0x81,
+    /// This command sets VCOM_DC value.
+    VcmDcSetting = 0x82,
+    /// After this command is issued, the chip would enter the program mode.
+    ///
+    /// After the programming procedure completed, a hardware reset is necessary for leaving program mode.
+    ///
+    /// The only one parameter is a check code, the command would be excuted if check code = 0xA5.
+    ProgramMode = 0xA0,
+    /// After this command is issued, the chip would enter the program mode.
+    ActiveProgramming = 0xA1,
+    /// The command is used for reading the content of OTP for checking the data of programming.
+    ///
+    /// The value of (n) is depending on the amount of programmed data, tha max address = 0xFFF.
+    ReadOtp = 0xA2,
+    /// Not shown in commands table, but used in init sequence
+    PowerOptimization = 0xf8,
+}
+
+impl traits::Command for Command {
+    /// Returns the address of the command
+    fn address(self) -> u8 {
+        self as u8
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use crate::traits::Command as CommandTrait;
+
+    #[test]
+    fn command_addr() {
+        assert_eq!(Command::PanelSetting.address(), 0x00);
+        assert_eq!(Command::DisplayRefresh.address(), 0x12);
+    }
+}

src/epd2in7/constants.rs

@@ -0,0 +1,56 @@
+// Based on https://github.com/waveshare/e-Paper/blob/master/RaspberryPi_JetsonNano/python/lib/waveshare_epd/epd2in7.py
+#[rustfmt::skip]
+pub(crate) const LUT_VCOM_DC: [u8; 44] = [
+0x00, 0x00,
+0x00, 0x08, 0x00, 0x00, 0x00, 0x02,
+0x60, 0x28, 0x28, 0x00, 0x00, 0x01,
+0x00, 0x14, 0x00, 0x00, 0x00, 0x01,
+0x00, 0x12, 0x12, 0x00, 0x00, 0x01,
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00
+];
+
+#[rustfmt::skip]
+pub(crate) const LUT_WW: [u8; 42] =[
+0x40, 0x08, 0x00, 0x00, 0x00, 0x02,
+0x90, 0x28, 0x28, 0x00, 0x00, 0x01,
+0x40, 0x14, 0x00, 0x00, 0x00, 0x01,
+0xA0, 0x12, 0x12, 0x00, 0x00, 0x01,
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+];
+
+#[rustfmt::skip]
+pub(crate) const LUT_BW: [u8; 42] =[
+0x40, 0x08, 0x00, 0x00, 0x00, 0x02,
+0x90, 0x28, 0x28, 0x00, 0x00, 0x01,
+0x40, 0x14, 0x00, 0x00, 0x00, 0x01,
+0xA0, 0x12, 0x12, 0x00, 0x00, 0x01,
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+];
+
+#[rustfmt::skip]
+pub(crate) const LUT_BB: [u8; 42] =[
+0x80, 0x08, 0x00, 0x00, 0x00, 0x02,
+0x90, 0x28, 0x28, 0x00, 0x00, 0x01,
+0x80, 0x14, 0x00, 0x00, 0x00, 0x01,
+0x50, 0x12, 0x12, 0x00, 0x00, 0x01,
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+];
+
+#[rustfmt::skip]
+pub(crate) const LUT_WB: [u8; 42] =[
+0x80, 0x08, 0x00, 0x00, 0x00, 0x02,
+0x90, 0x28, 0x28, 0x00, 0x00, 0x01,
+0x80, 0x14, 0x00, 0x00, 0x00, 0x01,
+0x50, 0x12, 0x12, 0x00, 0x00, 0x01,
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+];