Skip to content

Commit f64c531

Browse files
ellenspellensp
committed
separate from configuration
1 parent c042671 commit f64c531

File tree

2 files changed

+264
-221
lines changed

2 files changed

+264
-221
lines changed

‎_configuration/boot_status_screen.md

+181
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
---
2+
title: 'Boot and Status screens'
3+
description: 'Complete guide to Marlin configuration options.'
4+
5+
author: dust
6+
contrib:
7+
category: [ configuration ]
8+
---
9+
10+
# `_Bootscreen.h`
11+
The bootscreen is displayed before the Marlin splash screen. This is available on 128x64 mono lcd displays and character lcd displays.
12+
Requires: CUSTOM_STATUS_SCREEN_IMAGE
13+
Use [Marlin converter tool](https://marlinfw.org/tools/u8glib/converter.html) to generate custom bootscreens.
14+
15+
## Animation Options
16+
```cpp
17+
#define CUSTOM_BOOTSCREEN_ANIMATED
18+
#define CUSTOM_BOOTSCREEN_ANIMATED_FRAME_TIME // Each frame also has a duration
19+
#define CUSTOM_BOOTSCREEN_FRAME_TIME 500 // (ms) Same time for all frames
20+
```
21+
`CUSTOM_BOOTSCREEN_ANIMATED_FRAME_TIME` [See example for details](https://github.com/MarlinFirmware/Configurations/blob/import-2.1.x/config/examples/AnimationExample/_Bootscreen.h)<br>
22+
`CUSTOM_BOOTSCREEN_FRAME_TIME` Value specifies constant time between frames in ms.
23+
24+
## Bootscreen Options
25+
```cpp
26+
#define CUSTOM_BOOTSCREEN_TIMEOUT 3000 // (ms) timeout for the bootscreen
27+
#define CUSTOM_BOOTSCREEN_X 5
28+
#define CUSTOM_BOOTSCREEN_Y 5
29+
```
30+
31+
`CUSTOM_BOOTSCREEN_TIMEOUT` Value specifies the time the boot screen is displayed in ms. Default is 2500 if not specified.
32+
`CUSTOM_BOOTSCREEN_[X|Y]` Absolute pixel or character offet. If omitted is set to centre the image.
33+
34+
## Bitmap Options
35+
```cpp
36+
#define CUSTOM_BOOTSCREEN_BMPWIDTH 120
37+
#define CUSTOM_BOOTSCREEN_BMPHEIGHT 60
38+
#define CUSTOM_BOOTSCREEN_BOTTOM_JUSTIFY
39+
#define CUSTOM_BOOTSCREEN_INVERTED
40+
#define COMPACT_CUSTOM_BOOTSCREEN
41+
#define COMPACT_CUSTOM_BOOTSCREEN_EXT
42+
```
43+
44+
`CUSTOM_BOOTSCREEN_BMPWIDTH` Image width in pixels.<br>
45+
`CUSTOM_BOOTSCREEN_BMPHEIGHT` Image height in pixels. If omitted is calculated from image data.<br>
46+
`CUSTOM_BOOTSCREEN_INVERTED` Inverts the image. On and off pixels are swapped.<br>
47+
`COMPACT_CUSTOM_BOOTSCREEN` Use compressed image data to save some flash space<sup>*</sup>.<br>
48+
`COMPACT_CUSTOM_BOOTSCREEN_EXT` Use extended compressed image data to save some flash space<sup>*</sup>.
49+
50+
<sup>*</sup>Use the [Marlin converter tool](https://marlinfw.org/tools/u8glib/converter.html) To generate compressed data, it will automatically choose the best compression option for your image data.
51+
52+
## Character Options
53+
```cpp
54+
#define CHR0 "\x8" // Note: cannot be 0, 0 conflicts with string terminator character.
55+
#define CHR1 "\x1"
56+
#define CHR2 "\x2"
57+
#define CHR3 "\x3"
58+
#define CHR4 "\x4"
59+
#define CHR5 "\x5"
60+
#define CHR6 "\x6"
61+
#define CHR7 "\x7"
62+
```
63+
Define these characters so they can easily be used in custom boot screen strings.The display can have up to 8 custom characters.
64+
65+
## Character bootscreen example
66+
![Image](/assets/images/bootscreen/character%20bootscreen%20eg.png){: .floater.framed}
67+
68+
```cpp
69+
#define CHR0 "\x8" // Note: cannot be 0, 0 conflicts with string terminator character.
70+
#define CHR1 "\x1"
71+
#define CHR2 "\x2"
72+
#define CHR3 "\x3"
73+
#define CHR4 "\x4"
74+
#define CHR5 "\x5"
75+
#define CHR6 "\x6"
76+
#define CHR7 "\x7"
77+
78+
static PGMSTR(custom_boot_line_1, CHR0 " CUSTOM BOOT " CHR2 CHR3 CHR4);
79+
static PGMSTR(custom_boot_line_2, CHR1 " SCREEN TEST " CHR5 CHR6 CHR7);
80+
const char * const custom_boot_lines[] PROGMEM = { custom_boot_line_1, custom_boot_line_2 };
81+
82+
/**
83+
* Up to 8 custom characters of 5 x 8 pixels
84+
* Use an online editor such as https://maxpromer.github.io/LCD-Character-Creator/
85+
*/
86+
const static PROGMEM byte customBootChars[][8] = {
87+
{ // CHR0
88+
B00100,
89+
B01110,
90+
B11011,
91+
B01110,
92+
B10101,
93+
B01110,
94+
B00100,
95+
B00100
96+
}, { // CHR1
97+
B00001,
98+
B00001,
99+
B00011,
100+
B00010,
101+
B00110,
102+
B10100,
103+
B11100,
104+
B01000
105+
}, { // CHR2
106+
B00000,
107+
B00000,
108+
B00011,
109+
B00100,
110+
B01000,
111+
B01000,
112+
B10001,
113+
B10001
114+
}, { // CHR3
115+
B00000,
116+
B11111,
117+
B00000,
118+
B00000,
119+
B00000,
120+
B00000,
121+
B10001,
122+
B10001
123+
}, { // CHR4
124+
B00000,
125+
B00000,
126+
B11000,
127+
B00100,
128+
B00010,
129+
B00010,
130+
B10001,
131+
B10001
132+
}, { // CHR5
133+
B10000,
134+
B10000,
135+
B10000,
136+
B01000,
137+
B01000,
138+
B00100,
139+
B00011,
140+
B00000
141+
}, { // CHR6
142+
B00000,
143+
B00000,
144+
B00000,
145+
B10001,
146+
B01110,
147+
B00000,
148+
B00000,
149+
B11111
150+
}, { // CHR7
151+
B00001,
152+
B00001,
153+
B00001,
154+
B00010,
155+
B00010,
156+
B00100,
157+
B11000,
158+
B00000
159+
}
160+
};
161+
```
162+
# `_Statusscreen.h`
163+
The logo is displayed in the top left of the main Marlin status screen.
164+
This is available on 128x64 mono lcd displays.
165+
Requires: CUSTOM_STATUS_SCREEN_IMAGE
166+
Use [Marlin converter tool](https://marlinfw.org/tools/u8glib/converter.html) to generate custom status logos.
167+
168+
## Status logo options
169+
```cpp
170+
#define STATUS_BED_ANIM
171+
#define STATUS_BED_X 70
172+
#define STATUS_HEATERS_X 48
173+
#define STATUS_HOTEND_ANIM
174+
#define STATUS_LOGO_WIDTH 21
175+
#define STATUS_LOGO_X 0
176+
#define STATUS_LOGO_Y 0
177+
```
178+
`STATUS_BED_X` Postion of heated bed icon<br>
179+
`STATUS_HEATERS_X` Position of first hotend icon<br>
180+
`STATUS_LOGO_WIDTH`Width of status logo in bits<br>
181+
`STATUS_LOGO_[X|Y]` Start X|Y postion of status logo<br>

0 commit comments

Comments
 (0)