Skip to content

Commit 38831c9

Browse files
ty-porterty-porter
committed
Move configuration to a table for readability
1 parent ff41c3e commit 38831c9

1 file changed

Lines changed: 47 additions & 29 deletions

File tree

‎README.md‎

Lines changed: 47 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -80,40 +80,57 @@ The default configuration is as follows:
8080
}
8181
```
8282

83-
### Configuration Options
83+
### JSON Configuration
84+
85+
#### Global Options
86+
87+
The following configuration affects most display adapters or emulation as a whole.
88+
89+
| Key | Type | Description |
90+
| --- | ---- | ----------- |
91+
| pixel_outline | Integer | Size of the black border around each pixel. Only works on some adapters; others will ignore this configuration.
92+
| pixel_size | Integer | Size of the emulated LED. Helpful for emulating large matrices on small screens. Actual window size is the matrix size scaled by pixel size.
93+
| pixel_style | String | Style of the emulated LED. Supported pixel styles are "square", "circle", and "real". Some display adapters do not support all options and will revert to a supported style.
94+
| pixel_glow | Integer | Amount of glow to add to pixels. Currently only supported by "real" pixel style. Must be an integer >= 0.
95+
| display_adapter | String | Display adapter for the emulator. See Display Adapters section for details.
96+
| icon_path | Path | Relative path to a custom icon file (PNG, ICO, JPG/JPEG, etc.). If not set, the emulator window uses the default RGBME icon.
97+
| emulator_title | String | Custom title to display at the top of the emulator window. If not set, RGBME uses default debug text.
98+
| suppress_font_warnings | Boolean | Suppress BDF font parsing errors, such as for missing characters.
99+
| suppress_adapter_load_errors | Boolean | Suppress errors when loading display adapters.
100+
| log_level | String | Logging level for the emulator.
84101

85-
```
86-
pixel_outline (Integer): Size of the black border around each pixel. Only works on some adapters; others will ignore this configuration.
87-
pixel_size (Integer): Size of the emulated LED. Helpful for emulating large matrices on small screens. Actual window size is the matrix size scaled by pixel size.
88-
pixel_style (String): Style of the emulated LED. Supported pixel styles are "square", "circle", and "real". Some display adapters do not support all options and will revert to a supported style.
89-
pixel_glow (Integer): Amount of glow to add to pixels. Currently only supported by "real" pixel style. Must be an integer >= 0.
90-
display_adapter (String): Display adapter for the emulator. See Display Adapters section for details.
91-
icon_path (Path): Relative path to a custom icon file (PNG, ICO, JPG/JPEG, etc.). If not set, the emulator window uses the default RGBME icon.
92-
emulator_title (String): Custom title to display at the top of the emulator window. If not set, RGBME uses default debug text.
93-
suppress_font_warnings (Boolean): Suppress BDF font parsing errors, such as for missing characters.
94-
suppress_adapter_load_errors (Boolean): Suppress errors when loading display adapters.
95-
browser (Dict): Additional configuration options for the "browser" display adapter. Does nothing for other adapters.
96-
port (Integer): Port for the rendering server to attach to. Example: http://localhost:8888
97-
target_fps (Integer): Target frames per second. Higher values may lead to lower performance.
98-
fps_display (Bool): Display the FPS.
99-
quality (Intger): Value from 0 - 100 indicating the quality percentage for the rendered image. Higher values may lead to lower performance.
100-
image_border (Bool): Display a slight border around the rendered image.
101-
debug_text (Bool): Display debug text.
102-
image_format (String): Image format to use for rendering. Options are "JPEG" or "PNG".
103-
pi5 (Dict): Additional configuration options for the "pi5" display adapter. Does nothing for other adapters.
104-
pinout (String): The hardware pinout definition. Matches attributes in `piomatter.Pinout` (e.g., "Active3", "AdafruitMatrixHat", "AdafruitMatrixBonnet").
105-
n_addr_lines (Integer): Number of address lines for the display. Typically `4` for 32-pixel height panels, or `5` for 64-pixel height panels.
106-
led_rgb_sequence (String): Color sequence of the LEDs (e.g., "RGB", "BGR", "RBG").
107-
rotation (String): Display rotation. Matches attributes in `piomatter.Orientation` (e.g., "Normal", "R180", "CW", "CCW"). Does not work with "Active3" pinouts.
108-
n_lanes (Integer): Number of parallel matrix chains (lanes). Only works with Active3 boards. Must be 2 or more.
109-
n_planes (Integer): Colour Bit depth/number of planes. Maximum of 10, minimum of 1.
110-
n_temporal_planes (Integer): Number of temporal planes for dithering/brightness control. Possible values are 0, 2 or 4 and can't be greater than the value of n_planes.
111-
log_level (String): Logging level for the emulator.
112-
```
113102
Altering the `pixel_size` configuration will change how large the LEDs appear on your screen. This is helpful for emulating large matrices or on small screens.
114103

115104
You can also change the `pixel_style` option. By default, the emulator represents LEDs as squares. If you prefer the LEDs to have a more rounded appearance, you can change to `circle`. For simulating a real panel with LED "glow", the `real` style can be used.
116105

106+
#### Adapter-Specific Options
107+
108+
Certain adapters may specify additional configurations. These specialized configuration options do not affect other adapters.
109+
110+
##### `browser` Options
111+
112+
| Key | Type | Description |
113+
| --- | ---- | ----------- |
114+
| browser.port | Integer | Port for the rendering server to attach to. Example: http://localhost:8888
115+
| browser.target_fps | Integer | Target frames per second. Higher values may lead to lower performance.
116+
| browser.fps_display | Bool | Display the FPS.
117+
| browser.quality | Integer | Value from 0 - 100 indicating the quality percentage for the rendered image. Higher values may lead to lower performance.
118+
| browser.image_border | Bool | Display a slight border around the rendered image.
119+
| browser.debug_text | Bool | Display debug text.
120+
| browser.image_format | String | Image format to use for rendering. Options are "JPEG" or "PNG".
121+
122+
##### `pi5` Options
123+
124+
| Key | Type | Description |
125+
| --- | ---- | ----------- |
126+
| pi5.pinout | String | The hardware pinout definition. Matches attributes in `piomatter.Pinout` (e.g., "Active3", "AdafruitMatrixHat", "AdafruitMatrixBonnet").
127+
| pi5.n_addr_lines | Integer | Number of address lines for the display. Typically `4` for 32-pixel height panels, or `5` for 64-pixel height panels.
128+
| pi5.led_rgb_sequence | String | Color sequence of the LEDs (e.g., "RGB", "BGR", "RBG").
129+
| pi5.rotation | String | Display rotation. Matches attributes in `piomatter.Orientation` (e.g., "Normal", "R180", "CW", "CCW"). Does not work with "Active3" pinouts.
130+
| pi5.n_lanes | Integer | Number of parallel matrix chains (lanes). Only works with Active3 boards. Must be 2 or more.
131+
| pi5.n_planes | Integer | Colour Bit depth/number of planes. Maximum of 10, minimum of 1.
132+
| pi5.n_temporal_planes | Integer | Number of temporal planes for dithering/brightness control. Possible values are 0, 2 or 4 and can't be greater than the value of n_planes.
133+
117134
### Display Adapters
118135

119136
By default, `RGBMatrixEmulator` uses `browser` as its display adapter for maximum compatibility with different operating systems as well as thread-safety. However, you can also use other display adapters as well if the default adapter does not suit your needs.
@@ -126,6 +143,7 @@ Currently supported display adapters are:
126143
* `tkinter`
127144
* `turtle`
128145
* `sixel`
146+
* `pi5` (experimental)
129147
* `raw`
130148

131149
You can swap display adapters by changing the `display_adapter` value to one of the above in `emulator_config.json`.

0 commit comments

Comments
 (0)