Commit graph

208 commits

Author SHA1 Message Date
adumelie ef38472278 More typos in code example 2024-03-14 20:27:19 +01:00
adumelie 4c9d5332c7 Typo in code example 2024-03-14 20:27:19 +01:00
adumelie 9aa0bc8ecf Fix and update documentation
Fixed missing colon typo in template for minimal app example
Updated reference to Apps enum after file move
2024-03-14 20:27:19 +01:00
Graham Jones c2c53bc6ab
bma421: Change acceleration values to 'binary milli-G' units
Co-authored-by: FintasticMan <finlay.neon.kid@gmail.com>
2024-02-11 20:46:26 +01:00
Jean-François Milants 6505336d60 CMake watch faces selection
Documentation : watch faces are not system apps anymore.

Co-authored-by: FintasticMan <finlay.neon.kid@gmail.com>
2024-01-06 14:44:10 +01:00
Jean-François Milants 25b3e2461d CMake watch faces selection
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>
2024-01-06 14:44:10 +01:00
Jean-François Milants 72c992c84e Watch face selection using CMake
Update Apps.md to mention the selection of watchfaces using Cmake.
2024-01-06 14:44:10 +01:00
Jean-François Milants f34aede897 Simple Weather Service : Fix timestamp
Wording improvements in doc.

Co-authored-by: Reinhold Gschweicher <pyro4hell@gmail.com>
2024-01-04 13:00:01 +01:00
Jean-François Milants 95e2f9e701 Simple Weather Service : Fix timestamp
Mention that the timestamp should be expressed in localtime time.
2024-01-04 13:00:01 +01:00
Jean-François Milants b4ff1f9ca2 Simple Weather Service : Fix timestamp
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.
2024-01-04 13:00:01 +01:00
FintasticMan 3f51923c3b docs: Fix simple weather forecast message type 2024-01-03 20:58:58 +01:00
Jean-François Milants 2ee2b8523a User applications selection using CMake
Fix typos in Apps.md and add new line in src/displayapp/apps/CMakeLists.txt
2023-12-23 21:29:13 +01:00
JF 06171dad38 Fix trailing space in doc/code/Apps.md
Co-authored-by: NeroBurner <pyro4hell@gmail.com>
2023-12-23 21:29:13 +01:00
Jean-François Milants 1ad7840072 Watch face selection at build time
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.
2023-12-23 21:29:13 +01:00
Jean-François Milants f2996f54a8 CMake User Applications selection
Update documentation about building a new application and add instructions to add the app in CMake files.
2023-12-23 21:29:13 +01:00
Jean-François Milants ca7d8a668d Simple Weather Service
Fix ToUInt64() in SimpleWeatherService.cpp.
Fix typo in SimpleWeatherService.md.
2023-12-23 21:12:25 +01:00
Jean-François Milants d56df38aeb Simple Weather Service
Fix typo in doc/ble.md.
2023-12-23 21:12:25 +01:00
Jean-François Milants e5b73212f6 Simple Weather Service
Store temperatures as int16_t (instead of uint8_t previously). The temperature is expressed in °C * 100.
2023-12-23 21:12:25 +01:00
Jean-François Milants 3a8c7dc038 Simple Weather Service - code cleaning and improvements
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.
2023-12-23 21:12:25 +01:00
Jean-François Milants c94a59e7d3 SimpleWeather service : new weather implementation
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.
2023-12-23 21:12:25 +01:00
FintasticMan 69b9d30a30 p8: Fix build when building for P8 variants
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.
2023-12-16 11:43:31 +01:00
Jean-François Milants f3d4f04827 Application selection at build time : update documentation
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.
2023-11-19 21:13:55 +01:00
Alex E 930284adc2
docs: Update Apps.md to remove Screen param (#1752)
This is needed since #1629.

Co-authored-by: FintasticMan <finlay.neon.kid@gmail.com>
2023-11-16 18:46:25 +01:00
Reinhold Gschweicher 77546c9fe2 lv_img_conv_py: minimal python port of node module
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`.
2023-10-26 22:45:01 +02:00
Steve Amor 46b664b528 Corrects typo for make option for recovery-loader 2023-10-04 20:24:37 +02:00
JF 44d1798f4f
navigation: Move font to external memory (#1838)
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.
2023-09-02 19:41:51 +02:00
TailyFair 782ef7902f Include repository initialization in docker build docs 2023-08-11 21:08:26 +02:00
Finlay Davidson 3b084d74c3 branches: Update files to refer to main instead of develop 2023-03-02 09:45:47 +02:00
Riku Isokoski f4684f6ea5 CONTRIBUTING: Move from doc to root
This is so the GitHub UI picks it up correctly.
2023-02-20 22:27:10 +02:00
Finlay Davidson d968bcb1f3 docs: Limit number of jobs used for compilation 2023-02-19 20:26:08 +01:00
Tim Aschhoff 512ebf0704 Fix Link in buildWithVScode 2023-02-16 08:47:46 +02:00
Riku Isokoski 8e2dcda14f files-needed-by-factory: Adjust headers 2023-02-13 11:03:14 +02:00
Riku Isokoski dddca33d2f files-needed-by-factory: Move to separate document
These are instructions for maintainers, and should be in a separate
document.
2023-02-13 11:03:14 +02:00
Riku Isokoski 4e1a2aff47 contribute.md: Add commit format section
Inspired by:
https://www.klipper3d.org/CONTRIBUTING.html#format-of-commit-messages
2023-02-12 14:36:04 +02:00
Riku Isokoski f9d03cc396 contribute.md: Improve contributing instructions
Denser instructions for absolute beginners. Links to GitHub docs.

Add PR checklist and commit conventions sections based on the
maintainer's guide.
2023-02-12 14:36:04 +02:00
TailyFair 762d52e114 Fix Apps documentation DisplayApp method name 2023-01-22 09:08:06 +02:00
Riku Isokoski 4b75605412 contribute.md: Update
Cleaned up the list of things you can help with.
Added a few points
2023-01-22 09:02:47 +02:00
Riku Isokoski ee8349a676 doc: Add maintainer guide 2023-01-22 09:00:14 +02:00
John Paul Wohlscheid 2692231b95 minor grammar edits 2023-01-22 08:51:02 +02:00
tom-programming 361e381ac3 typo in the description
AMD64 and x86_64 are the same architecture - ARM64 should be specified instead
2022-12-06 12:06:57 +02:00
mashuptwice 957f7d2ec3 fixed filename 2022-10-10 12:43:11 +02:00
mashuptwice 668820ef5a Edit all occurences of "watchface" to "watch face" 2022-10-10 12:43:11 +02:00
Jean-François Milants 81ad89d6bc Add missing screenshot about the external resources support in Amazfish. 2022-10-05 21:07:11 +02:00
Jean-François Milants 60abbf0639 Add doc about external resources. 2022-10-02 12:27:10 +02:00
mashuptwice 809323df3a Applist is in ApplicationList.h 2022-09-17 21:29:48 +02:00
Jean-François Milants 6ed8e983e9 Remove CMake targets and corresponding CLI arguments that are specific to the debugging environment (USE_JLINK, USE_OPENOCD and USE_GDB_CLIENT). 2022-09-17 21:25:54 +02:00
Jean-François Milants c9a5c3fa5c Fix formatting. 2022-09-11 14:44:36 +02:00
Jean-François Milants cac9b3cc8e Add doc about the new parameter -DBUILD_RESOURCES. 2022-09-11 14:44:36 +02:00
Riku Isokoski c2b6a8de3e
Fix markdown format with autoformatter (#1284) 2022-08-21 14:50:09 +03:00
Riku Isokoski c495db8a71
Simplify coding style (#1280) 2022-08-21 14:44:05 +03:00