dfbc345511
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
107 lines
3.6 KiB
Markdown
107 lines
3.6 KiB
Markdown
# [InfiniSim](https://github.com/InfiniTimeOrg/InfiniSim)
|
|
|
|
[](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++)
|
|
|
|
On Ubuntu/Debian install the following packages:
|
|
|
|
```sh
|
|
sudo apt install -y cmake libsdl2-dev g++
|
|
```
|
|
|
|
On Arch Linux the following packages are needed:
|
|
|
|
```sh
|
|
sudo pacman -S cmake sdl2 gcc
|
|
```
|
|
|
|
## 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.
|
|
|
|
## Run Simulator
|
|
|
|
When the build was successful the simulator binary can be started with
|
|
|
|
```sh
|
|
./build/infinisim
|
|
```
|
|
|
|
|
|
|
|
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
|
|
- `N` ... clear all notifications
|
|
- `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
|
|
- `i` ... take screenshot
|
|
|
|
## 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.
|