1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
#![no_std]
// associated re-typing not supported in rust yet
#![allow(clippy::type_complexity)]

//! This crate provides a ST7789 driver to connect to TFT displays.

pub mod instruction;

use crate::instruction::Instruction;
use num_derive::ToPrimitive;
use num_traits::ToPrimitive;

use display_interface_spi::SPIInterface;

use display_interface::WriteOnlyDataCommand;
use embedded_hal::blocking::delay::DelayUs;
use embedded_hal::blocking::spi;
use embedded_hal::digital::v2::OutputPin;

#[cfg(feature = "graphics")]
mod graphics;

#[cfg(feature = "batch")]
mod batch;

/// Convenience function for creating a new display driver with SPI
/// # Arguments
///
/// * `spi` - an SPI interface to use for talking to the display
/// * `csx` - the chip select pin documented in the datasheet
/// * `dc` - data/clock pin switch
/// * `rst` - display hard reset pin
/// * `size_x` - x axis resolution of the display in pixels
/// * `size_y` - y axis resolution of the display in pixels
///
pub fn new_display_driver<SPI, CSX, DC, RST>(
    spi: SPI,
    csx: CSX,
    dc: DC,
    rst: RST,
    size_x: u16,
    size_y: u16,
) -> ST7789<SPIInterface<SPI, DC, CSX>, RST>
where
    SPI: spi::Write<u8>,
    CSX: OutputPin,
    DC: OutputPin,
    RST: OutputPin,
{
    let interface = SPIInterface::new(spi, dc, csx);
    ST7789::new(interface, rst, size_x as u16, size_y as u16)
}

///
/// ST7789 driver to connect to TFT displays.
///
pub struct ST7789<DI, RST>
where
    DI: WriteOnlyDataCommand<u8>,
    RST: OutputPin,
{
    // Display interface
    di: DI,
    // Reset pin.
    rst: RST,

    // Screen size
    size_x: u16,
    size_y: u16,
}

///
/// Display orientation.
///
#[derive(ToPrimitive)]
pub enum Orientation {
    Portrait = 0b0000_0000,         // no inverting
    Landscape = 0b0110_0000,        // invert column and page/column order
    PortraitSwapped = 0b1100_0000,  // invert page and column order
    LandscapeSwapped = 0b1010_0000, // invert page and page/column order
}

///
/// An error holding its source (pins or SPI)
///
#[derive(Debug)]
pub enum Error<PinE> {
    DisplayError,
    Pin(PinE),
}

impl<DI, RST, PinE> ST7789<DI, RST>
where
    DI: WriteOnlyDataCommand<u8>,
    RST: OutputPin<Error = PinE>,
{
    ///
    /// Creates a new ST7789 driver instance
    ///
    /// # Arguments
    ///
    /// * `spi` - an SPI interface to use for talking to the display
    /// * `di` - a display interface for talking with the display
    /// * `csx` - the chip select pin documented in the datasheet
    /// * `dc` - data/clock pin switch
    /// * `rst` - display hard reset pin
    /// * `size_x` - x axis resolution of the display in pixels
    /// * `size_y` - y axis resolution of the display in pixels
    ///
    pub fn new(di: DI, rst: RST, size_x: u16, size_y: u16) -> Self {
        Self {
            di,
            rst,
            size_x,
            size_y,
        }
    }

    ///
    /// Runs commands to initialize the display
    ///
    pub fn init(&mut self, delay_source: &mut impl DelayUs<u32>) -> Result<(), Error<PinE>> {
        self.hard_reset(delay_source)?;
        self.write_command(Instruction::SWRESET, None)?; // reset display
        delay_source.delay_us(150_000);
        self.write_command(Instruction::SLPOUT, None)?; // turn off sleep
        delay_source.delay_us(10_000);
        self.write_command(Instruction::INVOFF, None)?; // turn off invert
        self.write_command(Instruction::MADCTL, Some(&[0b0000_0000]))?; // left -> right, bottom -> top RGB
        self.write_command(Instruction::COLMOD, Some(&[0b0101_0101]))?; // 16bit 65k colors
        self.write_command(Instruction::INVON, None)?; // hack?
        delay_source.delay_us(10_000);
        self.write_command(Instruction::NORON, None)?; // turn on display
        delay_source.delay_us(10_000);
        self.write_command(Instruction::DISPON, None)?; // turn on display
        delay_source.delay_us(10_000);
        Ok(())
    }

    ///
    /// Performs a hard reset using the RST pin sequence
    ///
    pub fn hard_reset(&mut self, delay_source: &mut impl DelayUs<u32>) -> Result<(), Error<PinE>> {
        self.rst.set_high().map_err(Error::Pin)?;
        delay_source.delay_us(10); // ensure the pin change will get registered
        self.rst.set_low().map_err(Error::Pin)?;
        delay_source.delay_us(10); // ensure the pin change will get registered
        self.rst.set_high().map_err(Error::Pin)?;
        delay_source.delay_us(10); // ensure the pin change will get registered

        Ok(())
    }

    ///
    /// Sets display orientation
    ///
    pub fn set_orientation(&mut self, orientation: &Orientation) -> Result<(), Error<PinE>> {
        let orientation = orientation.to_u8().unwrap_or(0);
        self.write_command(Instruction::MADCTL, Some(&[orientation]))?;
        Ok(())
    }

    ///
    /// Sets a pixel color at the given coords.
    ///
    /// # Arguments
    ///
    /// * `x` - x coordinate
    /// * `y` - y coordinate
    /// * `color` - the Rgb565 color value
    ///
    pub fn set_pixel(&mut self, x: u16, y: u16, color: u16) -> Result<(), Error<PinE>> {
        self.set_address_window(x, y, x, y)?;
        self.write_command(Instruction::RAMWR, None)?;
        self.write_word(color)
    }

    ///
    /// Sets pixel colors in given rectangle bounds.
    ///
    /// # Arguments
    ///
    /// * `sx` - x coordinate start
    /// * `sy` - y coordinate start
    /// * `ex` - x coordinate end
    /// * `ey` - y coordinate end
    /// * `colors` - anything that can provide `IntoIterator<Item = u16>` to iterate over pixel data
    ///
    pub fn set_pixels<T>(
        &mut self,
        sx: u16,
        sy: u16,
        ex: u16,
        ey: u16,
        colors: T,
    ) -> Result<(), Error<PinE>>
    where
        T: IntoIterator<Item = u16>,
    {
        self.set_address_window(sx, sy, ex, ey)?;
        self.write_command(Instruction::RAMWR, None)?;
        self.write_pixels(colors)
    }

    #[cfg(not(feature = "buffer"))]
    fn write_pixels<T>(&mut self, colors: T) -> Result<(), Error<SPI, PinE>>
    where
        T: IntoIterator<Item = u16>,
    {
        for color in colors {
            self.write_word(color)?;
        }

        Ok(())
    }

    #[cfg(feature = "buffer")]
    fn write_pixels<T>(&mut self, colors: T) -> Result<(), Error<PinE>>
    where
        T: IntoIterator<Item = u16>,
    {
        let mut buf = [0; 128];
        let mut i = 0;

        for color in colors {
            let word = color.to_be_bytes();
            buf[i] = word[0];
            buf[i + 1] = word[1];
            i += 2;

            if i == buf.len() {
                self.write_data(&buf)?;
                i = 0;
            }
        }

        if i > 0 {
            self.write_data(&buf[..i])?;
        }

        Ok(())
    }

    fn write_command(
        &mut self,
        command: Instruction,
        params: Option<&[u8]>,
    ) -> Result<(), Error<PinE>> {
        self.di
            .send_commands(&[command.to_u8().unwrap()])
            .map_err(|_| Error::DisplayError)?;

        if let Some(params) = params {
            self.di.send_data(params).map_err(|_| Error::DisplayError)?;
        }

        Ok(())
    }

    fn write_data(&mut self, data: &[u8]) -> Result<(), Error<PinE>> {
        self.di.send_data(data).map_err(|_| Error::DisplayError)?;
        Ok(())
    }

    // Writes a data word to the display.
    fn write_word(&mut self, value: u16) -> Result<(), Error<PinE>> {
        self.write_data(&value.to_be_bytes())
    }

    // Sets the address window for the display.
    fn set_address_window(
        &mut self,
        sx: u16,
        sy: u16,
        ex: u16,
        ey: u16,
    ) -> Result<(), Error<PinE>> {
        self.write_command(Instruction::CASET, None)?;
        self.write_word(sx)?;
        self.write_word(ex)?;
        self.write_command(Instruction::RASET, None)?;
        self.write_word(sy)?;
        self.write_word(ey)
    }
}