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
// Shamefully taken from https://github.com/EdgewaterDevelopment/rust-ssd1306
use super::interface::DisplayInterface;
/// SSD1306 Commands
/// Commands
#[derive(Debug)]
#[allow(dead_code)]
pub enum Command {
/// Set contrast. Higher number is higher contrast. Default = 0x7F
Contrast(u8),
/// Turn entire display on. If set, all pixels will
/// be set to on, if not, the value in memory will be used.
AllOn(bool),
/// Invert display.
Invert(bool),
/// Turn display on or off.
DisplayOn(bool),
/// Set up horizontal scrolling.
/// Values are scroll direction, start page, end page,
/// and number of frames per step.
HScrollSetup(HScrollDir, Page, Page, NFrames),
/// Set up horizontal + vertical scrolling.
/// Values are scroll direction, start page, end page,
/// number of frames per step, and vertical scrolling offset.
/// Scrolling offset may be from 0-63
VHScrollSetup(VHScrollDir, Page, Page, NFrames, u8),
/// Enable scrolling
EnableScroll(bool),
/// Setup vertical scroll area.
/// Values are number of rows above scroll area (0-63)
/// and number of rows of scrolling. (0-64)
VScrollArea(u8, u8),
/// Set the lower nibble of the column start address
/// register for Page addressing mode, using the lower
/// 4 bits given.
/// This is only for page addressing mode
LowerColStart(u8),
/// Set the upper nibble of the column start address
/// register for Page addressing mode, using the lower
/// 4 bits given.
/// This is only for page addressing mode
UpperColStart(u8),
/// Set addressing mode
AddressMode(AddrMode),
/// Setup column start and end address
/// values range from 0-127
/// This is only for horizontal or vertical addressing mode
ColumnAddress(u8, u8),
/// Setup page start and end address
/// This is only for horizontal or vertical addressing mode
PageAddress(Page, Page),
/// Set GDDRAM page start address for Page addressing mode
PageStart(Page),
/// Set display start line from 0-63
StartLine(u8),
/// Reverse columns from 127-0
SegmentRemap(bool),
/// Set multipex ratio from 15-63 (MUX-1)
Multiplex(u8),
/// Scan from COM[n-1] to COM0 (where N is mux ratio)
ReverseComDir(bool),
/// Set vertical shift
DisplayOffset(u8),
/// Setup com hardware configuration
/// First value indicates sequential (false) or alternative (true)
/// pin configuration. Second value disables (false) or enables (true)
/// left/right remap.
ComPinConfig(bool, bool),
/// Set up display clock.
/// First value is oscillator frequency, increasing with higher value
/// Second value is divide ratio - 1
DisplayClockDiv(u8, u8),
/// Set up phase 1 and 2 of precharge period. each value is from 0-63
PreChargePeriod(u8, u8),
/// Set Vcomh Deselect level
VcomhDeselect(VcomhLevel),
/// NOOP
Noop,
/// Enable charge pump
ChargePump(bool),
}
impl Command {
/// Send command to SSD1306
pub fn send<DI>(self, iface: &mut DI) -> Result<(), ()>
where
DI: DisplayInterface,
{
// Transform command into a fixed size array of 7 u8 and the real length for sending
let (data, len) = match self {
Command::Contrast(val) => ([0x81, val, 0, 0, 0, 0, 0], 2),
Command::AllOn(on) => ([0xA4 | (on as u8), 0, 0, 0, 0, 0, 0], 1),
Command::Invert(inv) => ([0xA6 | (inv as u8), 0, 0, 0, 0, 0, 0], 1),
Command::DisplayOn(on) => ([0xAE | (on as u8), 0, 0, 0, 0, 0, 0], 1),
Command::HScrollSetup(dir, start, end, rate) => (
[
0x26 | (dir as u8),
0,
start as u8,
rate as u8,
end as u8,
0,
0xFF,
],
7,
),
Command::VHScrollSetup(dir, start, end, rate, offset) => (
[
0x28 | (dir as u8),
0,
start as u8,
rate as u8,
end as u8,
offset,
0,
],
6,
),
Command::EnableScroll(en) => ([0x2E | (en as u8), 0, 0, 0, 0, 0, 0], 1),
Command::VScrollArea(above, lines) => ([0xA3, above, lines, 0, 0, 0, 0], 3),
Command::LowerColStart(addr) => ([0xF & addr, 0, 0, 0, 0, 0, 0], 1),
Command::UpperColStart(addr) => ([0x1F & addr, 0, 0, 0, 0, 0, 0], 1),
Command::AddressMode(mode) => ([0x20, mode as u8, 0, 0, 0, 0, 0], 2),
Command::ColumnAddress(start, end) => ([0x21, start, end, 0, 0, 0, 0], 3),
Command::PageAddress(start, end) => ([0x22, start as u8, end as u8, 0, 0, 0, 0], 3),
Command::PageStart(page) => ([0xB0 | (page as u8), 0, 0, 0, 0, 0, 0], 1),
Command::StartLine(line) => ([0x40 | (0x3F & line), 0, 0, 0, 0, 0, 0], 1),
Command::SegmentRemap(remap) => ([0xA0 | (remap as u8), 0, 0, 0, 0, 0, 0], 1),
Command::Multiplex(ratio) => ([0xA8, ratio, 0, 0, 0, 0, 0], 2),
Command::ReverseComDir(rev) => ([0xC0 | ((rev as u8) << 3), 0, 0, 0, 0, 0, 0], 1),
Command::DisplayOffset(offset) => ([0xD3, offset, 0, 0, 0, 0, 0], 2),
Command::ComPinConfig(alt, lr) => (
[
0xDA,
0x2 | ((alt as u8) << 4) | ((lr as u8) << 5),
0,
0,
0,
0,
0,
],
2,
),
Command::DisplayClockDiv(fosc, div) => {
([0xD5, ((0xF & fosc) << 4) | (0xF & div), 0, 0, 0, 0, 0], 2)
}
Command::PreChargePeriod(phase1, phase2) => (
[0xD9, ((0xF & phase2) << 4) | (0xF & phase1), 0, 0, 0, 0, 0],
2,
),
Command::VcomhDeselect(level) => ([0xDB, (level as u8) << 4, 0, 0, 0, 0, 0], 2),
Command::Noop => ([0xE3, 0, 0, 0, 0, 0, 0], 1),
Command::ChargePump(en) => ([0x8D, 0x10 | ((en as u8) << 2), 0, 0, 0, 0, 0], 2),
};
// Send command over the interface
iface.send_commands(&data[0..len])?;
Ok(())
}
}
/// Horizontal Scroll Direction
#[derive(Debug, Clone, Copy)]
#[allow(dead_code)]
pub enum HScrollDir {
/// Left to right
LeftToRight = 0,
/// Right to left
RightToLeft = 1,
}
/// Vertical and horizontal scroll dir
#[derive(Debug, Clone, Copy)]
#[allow(dead_code)]
pub enum VHScrollDir {
/// Vertical and right horizontal
VerticalRight = 0b01,
/// Vertical and left horizontal
VerticalLeft = 0b10,
}
/// Display page
#[derive(Debug, Clone, Copy)]
pub enum Page {
/// Page 0
Page0 = 0b000,
/// Page 1
Page1 = 0b001,
/// Page 2
Page2 = 0b010,
/// Page 3
Page3 = 0b011,
/// Page 4
Page4 = 0b100,
/// Page 5
Page5 = 0b101,
/// Page 6
Page6 = 0b110,
/// Page 7
Page7 = 0b111,
}
impl From<u8> for Page {
fn from(val: u8) -> Page {
match val / 8 {
0 => Page::Page0,
1 => Page::Page1,
2 => Page::Page2,
3 => Page::Page3,
4 => Page::Page4,
5 => Page::Page5,
6 => Page::Page6,
7 => Page::Page7,
_ => panic!("Page too high"),
}
}
}
/// Frame interval
#[derive(Debug, Clone, Copy)]
#[allow(dead_code)]
pub enum NFrames {
/// 2 Frames
F2 = 0b111,
/// 3 Frames
F3 = 0b100,
/// 4 Frames
F4 = 0b101,
/// 5 Frames
F5 = 0b000,
/// 25 Frames
F25 = 0b110,
/// 64 Frames
F64 = 0b001,
/// 128 Frames
F128 = 0b010,
/// 256 Frames
F256 = 0b011,
}
/// Address mode
#[derive(Debug, Clone, Copy)]
#[allow(dead_code)]
pub enum AddrMode {
/// Horizontal mode
Horizontal = 0b00,
/// Vertical mode
Vertical = 0b01,
/// Page mode (default)
Page = 0b10,
}
/// Vcomh Deselect level
#[derive(Debug, Clone, Copy)]
#[allow(dead_code)]
pub enum VcomhLevel {
/// 0.65 * Vcc
V065 = 0b001,
/// 0.77 * Vcc
V077 = 0b010,
/// 0.83 * Vcc
V083 = 0b011,
/// Auto
Auto = 0b100,
}