Difference between revisions of "Configuring Display Devices"
(Created page with "=Custom displays= Look in the “custom” folder in the zynthian-sys GitHub repository. Inside there is a subfolder called “display”, and inside that is a subfolder for...") |
(Adds description of webconf Display fields.) |
||
| (4 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
=Custom displays= | =Custom displays= | ||
| − | Look in the “custom” folder in the zynthian-sys GitHub repository. Inside there is a subfolder called “display”, and inside that is a subfolder for every device that requires customized config files: | + | Look in the “custom” folder in the zynthian-sys GitHub repository. Inside, there is a subfolder called “display”, and inside that is a subfolder for every device that requires customized config files: |
| − | '''zynthian-sys''' - System config files for Zynthian. Adjustments and adds. | + | '''zynthian-sys''' - System config files for Zynthian. Adjustments and adds. The device’s subfolder name should match the name used in the webconf tool. |
| − | |||
| − | The device’s subfolder name should match the name used in the webconf tool. | ||
As you see, currently there are only 2 customized devices (the 2 officially supported displays), but more displays should be added, specially for getting touch support out-the-box. | As you see, currently there are only 2 customized devices (the 2 officially supported displays), but more displays should be added, specially for getting touch support out-the-box. | ||
| Line 12: | Line 10: | ||
Please consider helping to add more devices to the “custom” folder. It’s easy: When you have a configuration that works for you: | Please consider helping to add more devices to the “custom” folder. It’s easy: When you have a configuration that works for you: | ||
| − | 1.) Copy the files you have customized in | + | 1.) Copy the files you have customized in these places: |
| − | + | * /etc | |
| − | + | * /boot/firmware/overlays | |
| − | |||
to a subfolder inside “/zynthian/zynthian-sys/custom”, with the same name used by the webconf tool. You must re-create the directory structure inside the subfolder. Take a look at the existing examples. | to a subfolder inside “/zynthian/zynthian-sys/custom”, with the same name used by the webconf tool. You must re-create the directory structure inside the subfolder. Take a look at the existing examples. | ||
| − | 2.) Try to re-configure your display from the webconf tool. If it still work after this, probably you did good work in the previous step, so we can continue. | + | 2.) Try to re-configure your display from the webconf tool. If it still work after this, probably you did a good work in the previous step, so we can continue. If not ... try to find the problem ;-) |
3.) Fork the zynthian-sys repository and copy/upload the new custom subfolder with its content, as you do it in the step 1. | 3.) Fork the zynthian-sys repository and copy/upload the new custom subfolder with its content, as you do it in the step 1. | ||
| − | 4.) Send a pull request with some explanation and I will review the changes and merge with the master repo for making available the custom configuration in the next update | + | 4.) Send a pull request with some explanation and I will review the changes and merge with the master repo for making available the custom configuration in the next software update. |
| + | |||
| + | =Webconf Configuration= | ||
| + | Webconf shows several fields to allow configuration of custom displays as described in this table. | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |+ Caption text | ||
| + | |- | ||
| + | ! Field !! Type !! Use | ||
| + | |- | ||
| + | |Display || Dropdown || Select a preset display from a list of templates. Populates other fields below. | ||
| + | |- | ||
| + | | Config || Text || Entries to be added to config.txt. May be used to enable and configure overlays. | ||
| + | |- | ||
| + | | Width || Text (numerical) || Defines the display width. Used by UI code. | ||
| + | |- | ||
| + | | Height || Text (numerical) || Defines the display height. Used by UI code. | ||
| + | |- | ||
| + | | Touch Rotation || Dropdown || Defines touch interface rotation. Used by touch driver. | ||
| + | |- | ||
| + | | Kernel Options || Text || Entries to be added to the kernel options. May be used to configure display. | ||
| + | |- | ||
| + | | Framebuffer || Text || Defines the framebuffer device path. Used by UI code and X Server. | ||
| + | |- | ||
| + | |} | ||
Latest revision as of 06:56, 3 October 2025
1 Custom displays
Look in the “custom” folder in the zynthian-sys GitHub repository. Inside, there is a subfolder called “display”, and inside that is a subfolder for every device that requires customized config files:
zynthian-sys - System config files for Zynthian. Adjustments and adds. The device’s subfolder name should match the name used in the webconf tool.
As you see, currently there are only 2 customized devices (the 2 officially supported displays), but more displays should be added, specially for getting touch support out-the-box.
2 Adding new custom display configurations
Please consider helping to add more devices to the “custom” folder. It’s easy: When you have a configuration that works for you:
1.) Copy the files you have customized in these places:
- /etc
- /boot/firmware/overlays
to a subfolder inside “/zynthian/zynthian-sys/custom”, with the same name used by the webconf tool. You must re-create the directory structure inside the subfolder. Take a look at the existing examples.
2.) Try to re-configure your display from the webconf tool. If it still work after this, probably you did a good work in the previous step, so we can continue. If not ... try to find the problem ;-)
3.) Fork the zynthian-sys repository and copy/upload the new custom subfolder with its content, as you do it in the step 1.
4.) Send a pull request with some explanation and I will review the changes and merge with the master repo for making available the custom configuration in the next software update.
3 Webconf Configuration
Webconf shows several fields to allow configuration of custom displays as described in this table.
| Field | Type | Use |
|---|---|---|
| Display | Dropdown | Select a preset display from a list of templates. Populates other fields below. |
| Config | Text | Entries to be added to config.txt. May be used to enable and configure overlays. |
| Width | Text (numerical) | Defines the display width. Used by UI code. |
| Height | Text (numerical) | Defines the display height. Used by UI code. |
| Touch Rotation | Dropdown | Defines touch interface rotation. Used by touch driver. |
| Kernel Options | Text | Entries to be added to the kernel options. May be used to configure display. |
| Framebuffer | Text | Defines the framebuffer device path. Used by UI code and X Server. |