{
"properties": {
"week_starts_on": {
"default": "Monday",
"description": "The day week starts on",
"enum": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"title": "Week starts on",
"type": "string"
},
"show_events": {
"default": true,
"description": "Whether to show events",
"title": "Show events",
"type": "boolean"
},
"ical_urls": {
"default": [],
"description": "List of iCal URLs",
"items": {
"type": "string"
},
"title": "iCal URLs",
"type": "array"
},
"ical_files": {
"default": [],
"description": "List of local iCal files",
"items": {
"type": "string"
},
"title": "iCal files",
"type": "array"
},
"date_format": {
"default": "ddd D MMM",
"description": "Date format",
"title": "Date format",
"type": "string"
},
"time_format": {
"default": "HH: mm",
"description": "Time format",
"title": "Time format",
"type": "string"
}
},
"title": "CalendarConfig",
"type": "object"
}
Inkycal Web-UI
Instructions
This is the Inkycal-Web-UI you can use to generate a settings.json file required for InkycalAfter filling in the general settings, add as many modules as you need and will out all required parameters
After completion, click on the generate settings file button to download the json file.
Copy this json file into the bootfs directory of your Raspberry Pi, which can be accessed directly from the microSC card over a pc
⚠️ Please note that the preview function is still experimental. It will not reflect changes after the first preview.
The devs are working on this, but it will require a bit more time
Click on a parameter below to find out what it does:
Select which display is connected to your Raspberry Pi via
the driver board. The best place to check is your invoice or order confirmation. There should be
a note about the resolution and display size. Please note that the version number of the
displays in the web-ui does not correspond to the display type by the manufacturer.
The update interval sets how often new content should be shown on the display. For 3-colour
displays, once every 60 minutes is recommended, while for black-white displays or grayscale
displays, you can go as low as one update every 10 minutes. Please note that updating the display
too frequently can reduce the lifespan of the display.
The orientation allows displaying the content upside down if you have assembled your Inkycal that
way.
By setting the language, modules supporting the language option will be able to display content in
your native language.
The fontsize makes the text in all modules larger or smaller. We recommend starting with the default
(12), and then adjust the font-size as needed.
Padding of the y-axis (vertical direction) creates a small gap between the display and the content.
As a result, you will see a small empty space at the top and bottom. This is useful if your
front-panel on the display is covering up a small section of the display.
Padding of the x-axis (horizontal direction) creates a small gap between the display and the
content. As a result, you will see a small empty space at the right and left edges of the display.
This is useful if your front-panel on the display is covering up a small section of the display.
The debug-section is a small section at the very bottom of the display. It consists of a single line
and shows if the modules encountered some errors. It also shows the time of the last update. If you
are having issues with some of the modules, this may give a hint which module is having the issue.
Setting this to true will display borders around modules. Just a visual effect which can be useful
for debugging.
E-Paper displays work differently from LCD-displays. Displaying the same or similar content over and
over leads to an effect called ghosting, where parts of the older images show up on the latest
image. To counter this issue, the display is flushed several times with its supported colours.
Although this process does take several minutes to complete, it is important not to skip this to
retain the same contrast and brilliance of the colours as well as preventing ghosting. This process
is called calibration as it calibrates the colours back to their original state. We recommend three
calibrations a day, spread throughout the day. It's best to pick hours where you are less likely to
look at the display as it will flicker for some time until it's completed.