CCF_100
/
InfiniSim
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
InfiniSim/README.md

122 lines
4.1 KiB
Markdown
Raw Normal View History Unescape Escape

Initial InfiniSim project
2022-02-16 14:42:29 +07:00
# [InfiniSim](https://github.com/InfiniTimeOrg/InfiniSim)
[![Build InfiniSim LVGL Simulator](https://github.com/InfiniTimeOrg/InfiniSim/actions/workflows/lv_sim.yml/badge.svg)](https://github.com/InfiniTimeOrg/InfiniSim/actions/workflows/lv_sim.yml)
Simulator for [InfiniTime](https://github.com/InfiniTimeOrg/InfiniTime) project.
Experience the `InfiniTime` user interface directly on your PC, to shorten the time until you get your hands on a real [PineTime smartwatch](https://www.pine64.org/pinetime/).
Or use it to develop new Watchfaces, new Screens, or quickly iterate on the user interface.
For a history on how this simulator started and the challenges on its way visit the [original PR](https://github.com/InfiniTimeOrg/InfiniTime/pull/743).
## Build dependencies
- CMake
- SDL2 (provides the simulator window, handles mouse and keyboard input)
- Compiler (g++ or clang++)
Use infinitime_fonts target if fonts/CMakeLists.txt exists Since https://github.com/InfiniTimeOrg/InfiniTime/pull/1097 the fonts are generated. Support this new way of using fonts. When InfiniTime isn't a subdirectory of InfiniSim we need to provide the binary dir when using `add_subdirectory()`. Use `fonts`. Update README with instructions to install `lv_font_conv`.
2022-05-10 16:56:45 +07:00
- [lv_font_conv](https://github.com/lvgl/lv_font_conv#install-the-script) (for `font.c` generation since [InfiniTime#1097](https://github.com/InfiniTimeOrg/InfiniTime/pull/1097))
Initial InfiniSim project
2022-02-16 14:42:29 +07:00
On Ubuntu/Debian install the following packages:
```sh
Use infinitime_fonts target if fonts/CMakeLists.txt exists Since https://github.com/InfiniTimeOrg/InfiniTime/pull/1097 the fonts are generated. Support this new way of using fonts. When InfiniTime isn't a subdirectory of InfiniSim we need to provide the binary dir when using `add_subdirectory()`. Use `fonts`. Update README with instructions to install `lv_font_conv`.
2022-05-10 16:56:45 +07:00
sudo apt install -y cmake libsdl2-dev g++ npm
Initial InfiniSim project
2022-02-16 14:42:29 +07:00
```
On Arch Linux the following packages are needed:
```sh
Use infinitime_fonts target if fonts/CMakeLists.txt exists Since https://github.com/InfiniTimeOrg/InfiniTime/pull/1097 the fonts are generated. Support this new way of using fonts. When InfiniTime isn't a subdirectory of InfiniSim we need to provide the binary dir when using `add_subdirectory()`. Use `fonts`. Update README with instructions to install `lv_font_conv`.
2022-05-10 16:56:45 +07:00
sudo pacman -S cmake sdl2 gcc npm
Initial InfiniSim project
2022-02-16 14:42:29 +07:00
```
doc: add fedora required packages
2022-04-02 15:55:03 +07:00
On Fedora the following packages are needed:
```sh
sudo dnf install cmake SDL2-devel gcc
```
Use infinitime_fonts target if fonts/CMakeLists.txt exists Since https://github.com/InfiniTimeOrg/InfiniTime/pull/1097 the fonts are generated. Support this new way of using fonts. When InfiniTime isn't a subdirectory of InfiniSim we need to provide the binary dir when using `add_subdirectory()`. Use `fonts`. Update README with instructions to install `lv_font_conv`.
2022-05-10 16:56:45 +07:00
Then install the `lv_font_conv` executable to the source directory (will be installed at `node_modules/.bin/lv_font_conv`)
```sh
npm install lv_font_conv@1.5.2
```
Initial InfiniSim project
2022-02-16 14:42:29 +07:00
## Get the Sources
Clone this repository and tell `git` to recursively download the submodules as well
```sh
git clone --recursive https://github.com/InfiniTimeOrg/InfiniSim.git
```
If you've already cloned the repository without the submodules (or you want to update them to the latest checked in version) run the following command:
```sh
git submodule update --init --recursive
```
## Configure and Build
In the most basic configuration tell cmake to configure the project and build it with the following two commands:
```sh
cmake -S . -B build
cmake --build build -j4
```
The following configuration settings can be added to the first `cmake -S . -B build` call
- `-DInfiniTime_DIR=InfiniTime`: a full path to an existing InfiniTime repository checked out.
Inside that directory the `src/libs/lvgl` submodule must be checked out as well.
The default value points to the InfiniTime submodule in this repository.
Cst816s: scale down SDL mouse coordinates according to MONITOR_ZOOM The lv_drivers provided monitor driver supports a `MONITOR_ZOOM`-factor which scales the window by the set factor. This is 'useful when simulating small screens'. The zoom can be set as cmake configuration setting `-DMONITOR_ZOOM=1`. Probably even more usefull for high-dpi screens where 240 pixels is really tiny.
2022-03-30 12:49:17 +07:00
- `-DMONITOR_ZOOM=1`: scale simulator window by this factor
Initial InfiniSim project
2022-02-16 14:42:29 +07:00
## Run Simulator
When the build was successful the simulator binary can be started with
```sh
./build/infinisim
```
![Running Simulator](https://user-images.githubusercontent.com/9076163/151057090-66fa6b10-eb4f-4b62-88e6-f9f307a57e40.gif)
To hide the second simulator-status-window start the binary with the `--hide-status` option
```sh
./build/infinisim --hide-status
```
- Left mouse button: simulates your finger, just click to tap, click and drag to swipe
- Right mouse button: simulates the hardware button (for example turn the screen off or on again)
Using the keyboard the following events can be triggered:
- `r` ... enable ringing
- `R` ... disable ringing
- `m` ... let motor run for 100 ms
- `M` ... let motor run for 255 ms
- `n` ... send notification
main: Fix 'N' clear new notification flag documentation The documentation for the 'N' key wrongly stated it clears all notifications. But in the code we see that just the new notification flag is reset.
2022-05-16 16:45:34 +07:00
- `N` ... clear new notification flag
Initial InfiniSim project
2022-02-16 14:42:29 +07:00
- `b` ... connect Bluetooth
- `B` ... disconnect Bluetooth
- `v` ... increase battery voltage and percentage
- `V` ... decrease battery voltage and percentage
- `c` ... charging,
- `C` ... not charging
- `l` ... increase brightness level
- `L` ... lower brightness level
- `p` ... enable print lvgl memory usage to terminal
- `P` ... disable print memory usage
- `s` ... increase step count by 500 steps
- `S` ... decrease step count by 500 steps
- `h` ... set heartrate running, and on further presses increase by 10 bpm
- `H` ... stop heartrate
main: implement saveScreenshot() writing bmp/png from SDL window buffer When pressing `i` create a screenshot of the current InfiniTime screen by dumping it to a timestamped png or bmp file like `InfiniSim_2022-03-08_203421.png`. Add a new configure option `WITH_PNG` with default `ON`. When switched to `OFF` the screenshots will be created in `bmp` format. Fixes: https://github.com/InfiniTimeOrg/InfiniSim/issues/5
2022-03-02 15:05:28 +07:00
- `i` ... take screenshot
Initial InfiniSim project
2022-02-16 14:42:29 +07:00
## Licenses
This project is released under the GNU General Public License version 3 or, at your option, any later version.
The same license as [InfiniTime](https://github.com/InfiniTimeOrg/InfiniTime).
The simulator is based on [lv_sim_eclipse_sdl](https://github.com/lvgl/lv_sim_eclipse_sdl) project under the MIT license.