aboutsummaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* bma421: Change acceleration values to 'binary milli-G' unitsGraham Jones2024-02-111-0/+2
| | | Co-authored-by: FintasticMan <finlay.neon.kid@gmail.com>
* CMake watch faces selectionJean-François Milants2024-01-061-1/+1
| | | | | | Documentation : watch faces are not system apps anymore. Co-authored-by: FintasticMan <finlay.neon.kid@gmail.com>
* CMake watch faces selectionJean-François Milants2024-01-061-12/+13
| | | | | | | Improve wording and replace "watchface" by "watch face" in Apps.md. Improve CMake readability regarding watch face selection Co-authored-by: Reinhold Gschweicher <pyro4hell@gmail.com>
* Watch face selection using CMakeJean-François Milants2024-01-061-4/+42
| | | | Update Apps.md to mention the selection of watchfaces using Cmake.
* Simple Weather Service : Fix timestampJean-François Milants2024-01-041-2/+2
| | | | | | Wording improvements in doc. Co-authored-by: Reinhold Gschweicher <pyro4hell@gmail.com>
* Simple Weather Service : Fix timestampJean-François Milants2024-01-041-2/+2
| | | | Mention that the timestamp should be expressed in localtime time.
* Simple Weather Service : Fix timestampJean-François Milants2024-01-041-2/+2
| | | | | In the documentation, specify that the timestamp is expressed in seconds from epoch (instead of nanoseconds). SimpleWeatherService now uses "localtime" (GetCurrentDateTime()) instead of UTC time.
* docs: Fix simple weather forecast message typeFintasticMan2024-01-031-2/+2
|
* User applications selection using CMakeJean-François Milants2023-12-231-1/+4
| | | | Fix typos in Apps.md and add new line in src/displayapp/apps/CMakeLists.txt
* Fix trailing space in doc/code/Apps.mdJF2023-12-231-1/+1
| | | Co-authored-by: NeroBurner <pyro4hell@gmail.com>
* Watch face selection at build timeJean-François Milants2023-12-231-14/+2
| | | | Replace the options that allowed to select the user apps independently by a single string variable that contains the ordered list of apps to build.
* CMake User Applications selectionJean-François Milants2023-12-231-1/+19
| | | | Update documentation about building a new application and add instructions to add the app in CMake files.
* Simple Weather ServiceJean-François Milants2023-12-231-1/+2
| | | | | Fix ToUInt64() in SimpleWeatherService.cpp. Fix typo in SimpleWeatherService.md.
* Simple Weather ServiceJean-François Milants2023-12-231-1/+1
| | | | Fix typo in doc/ble.md.
* Simple Weather ServiceJean-François Milants2023-12-231-21/+21
| | | | Store temperatures as int16_t (instead of uint8_t previously). The temperature is expressed in °C * 100.
* Simple Weather Service - code cleaning and improvementsJean-François Milants2023-12-231-3/+3
| | | | | | | Add missing icons (heavy clouds, thunderstorm, snow). Remove unneeded comparison operator (!=), improve conversion of Timestamp and MessageType, order includes. Fix typo in documentation. Remove not related change in StopWatch.
* SimpleWeather service : new weather implementationJean-François Milants2023-12-232-1/+72
| | | | | | | | | | This new implementation of the weather feature provides a new BLE API and a new weather service. The API uses a single characteristic that allows companion apps to write the weather conditions (current and forecast for the next 5 days). The SimpleWeather service exposes those data as std::optional fields. This new implementation replaces the previous WeahterService. The API is documented in docs/SimpleWeatherService.md.
* p8: Fix build when building for P8 variantsFintasticMan2023-12-161-1/+1
| | | | | | | Building with a TARGET_DEVICE set to any of the P8 variants' names caused the build to fail, because they contained hyphens. The build defines a macro `TARGET_DEVICE_$VARIANT`, which fails if `$VARIANT` contains a hyphen.
* Application selection at build time : update documentationJean-François Milants2023-11-191-30/+88
| | | | Update documentation about the apps (Apps.md) : fix obsolete information, add doc about user/system apps and update the part about the implementation of a new app.
* docs: Update Apps.md to remove Screen param (#1752)Alex E2023-11-161-2/+2
| | | | | This is needed since #1629. Co-authored-by: FintasticMan <finlay.neon.kid@gmail.com>
* lv_img_conv_py: minimal python port of node moduleReinhold Gschweicher2023-10-261-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Create a minimal python port of the node.js module `lv_img_conv`. Only the currently in use color formats `CF_INDEXED_1_BIT` and `CF_TRUE_COLOR_ALPHA` are implemented. Output only as binary with format `ARGB8565_RBSWAP`. This is enough to create the `resources-1.13.0.zip`. Python3 implements "propper" "banker's rounding" by rounding to the nearest even number. Javascript rounds to the nearest integer. To have the same output as the original JavaScript implementation add a custom rounding function, which does "school" rounding (to the nearest integer) Update CMake file in `resources` folder to call `lv_img_conf.py` instead of node module. For docker-files install `python3-pil` package for `lv_img_conv.py` script. And remove the `lv_img_conv` node installation. --- gen_img: special handling for python lv_img_conv script Not needed on Linux systems, as the shebang of the python script is read and used. But just to be sure use the python interpreter found by CMake. Also helps if tried to run on Windows host. --- doc: buildAndProgram: remove node script lv_img_conv mention Remove node script `lv_img_conv` mention and replace it for runtime-depency `python3-pil` of python script `lv_img_conv.py`.
* Corrects typo for make option for recovery-loaderSteve Amor2023-10-041-1/+1
|
* navigation: Move font to external memory (#1838)JF2023-09-021-1/+11
| | | | | | | | | | The TTF font used by the navigation app is ~20KB and is stored in internal flash memory. To free this space, the TTF font is now converted in 2 "atlas pictures" (pictures that contain multiple concatenated images) stored in the external flash memory. The navigation app now accesses one of those 2 files and apply an offset to display the desired picture. The corresponding documentation has also been updated. Add comments about the layout of the pictures that contain the icon and about the indexing of those icons. In documentation (buildAndProgram.md), edit the section about the debug compilation mode. Remove the part about removing the Navigation app to free some memory (since it's not relevant anymore) and explain how to selectively build parts of the firmware in Debug mode.
* Include repository initialization in docker build docsTailyFair2023-08-111-0/+10
|
* branches: Update files to refer to main instead of developFinlay Davidson2023-03-025-14/+12
|
* CONTRIBUTING: Move from doc to rootRiku Isokoski2023-02-201-61/+0
| | | | This is so the GitHub UI picks it up correctly.
* docs: Limit number of jobs used for compilationFinlay Davidson2023-02-191-2/+2
|
* Fix Link in buildWithVScodeTim Aschhoff2023-02-161-1/+1
|
* files-needed-by-factory: Adjust headersRiku Isokoski2023-02-131-2/+2
|
* files-needed-by-factory: Move to separate documentRiku Isokoski2023-02-132-38/+37
| | | | | These are instructions for maintainers, and should be in a separate document.
* contribute.md: Add commit format sectionRiku Isokoski2023-02-121-0/+14
| | | | | Inspired by: https://www.klipper3d.org/CONTRIBUTING.html#format-of-commit-messages
* contribute.md: Improve contributing instructionsRiku Isokoski2023-02-121-7/+26
| | | | | | | Denser instructions for absolute beginners. Links to GitHub docs. Add PR checklist and commit conventions sections based on the maintainer's guide.
* Fix Apps documentation DisplayApp method nameTailyFair2023-01-221-1/+1
|
* contribute.md: UpdateRiku Isokoski2023-01-221-6/+15
| | | | | Cleaned up the list of things you can help with. Added a few points
* doc: Add maintainer guideRiku Isokoski2023-01-221-0/+45
|
* minor grammar editsJohn Paul Wohlscheid2023-01-221-4/+4
|
* typo in the descriptiontom-programming2022-12-061-1/+1
| | | AMD64 and x86_64 are the same architecture - ARM64 should be specified instead
* fixed filenamemashuptwice2022-10-101-1/+1
|
* Edit all occurences of "watchface" to "watch face"mashuptwice2022-10-104-7/+7
|
* Add missing screenshot about the external resources support in Amazfish.Jean-François Milants2022-10-052-0/+0
|
* Add doc about external resources.Jean-François Milants2022-10-023-0/+102
|
* Applist is in ApplicationList.hmashuptwice2022-09-171-1/+1
|
* Remove CMake targets and corresponding CLI arguments that are specific to ↵Jean-François Milants2022-09-171-38/+2
| | | | the debugging environment (USE_JLINK, USE_OPENOCD and USE_GDB_CLIENT).
* Fix formatting.Jean-François Milants2022-09-111-11/+11
|
* Add doc about the new parameter `-DBUILD_RESOURCES`.Jean-François Milants2022-09-111-11/+12
|
* Fix markdown format with autoformatter (#1284)Riku Isokoski2022-08-2124-296/+407
|
* Simplify coding style (#1280)Riku Isokoski2022-08-211-37/+25
|
* Simplify contribute.md (#1281)Riku Isokoski2022-08-211-55/+13
|
* Move all images to doc. Remove old images. (#1282)Riku Isokoski2022-08-215-2/+2
|
* Docs reorganization (#1236)Riku Isokoski2022-07-214-131/+132
| | | | | | | * Docs reorganization Removed broken link * README.md relative link consistency