2019-08-02 13:58:12 +00:00
# Emulator
Emulator is a unix version of Core firmware that runs on your computer.
There is neither boardloader nor bootloader and no firmware uploads. Emulator runs the current code as is it is and if you want to run some specific firmware version you need to use git for that (simply checkout the right branch/tag). Actually, maybe we should call it _simulator_ to be precise, because it does not emulate the device in its completeness, it just runs the firmware on your host.
Emulator significantly speeds up development and has several features to help you along the way.
## How to run
1. [build ](../build/emulator.md ) the emulator
2020-09-25 14:21:23 +00:00
2. run `emu.py` inside the poetry environment:
- either enter `poetry shell` first, and then use `./emu.py`
- or always use `poetry run ./emu.py`
2021-03-17 14:02:52 +00:00
3. to use [bridge ](https://github.com/trezor/trezord-go ) with the emulator support, start it with `trezord-go -e 21324`
2019-08-02 13:58:12 +00:00
2021-04-16 14:18:48 +00:00
Now you can use the emulator the same way as you use the device, for example you can use [Trezor Suite ](https://suite.trezor.io ), use our Python CLI tool (`trezorctl`), etc. Simply click to emulate screen touches.
2019-08-02 13:58:12 +00:00
## Features
2020-01-16 14:14:08 +00:00
Run `./emu.py --help` to see all supported command line options and shortcuts. The
sections below only list long option names and most notable features.
2019-08-02 13:58:12 +00:00
2020-01-16 14:14:08 +00:00
### Debug and production mode
By default the emulator runs in debug mode. Debuglink is available (on port 21325 by
default), exceptions and log output goes to console. To indicate debug mode, there is a
red square in the upper right corner of Trezor screen.
2019-08-02 13:58:12 +00:00
2020-01-16 14:14:08 +00:00
To enable production mode, run `./emu.py --production` , or set environment variable `PYOPT=1` .
2019-08-02 13:58:12 +00:00
### Initialize with mnemonic words
2020-01-16 14:14:08 +00:00
In debug mode, the emulator can be pre-configured with a mnemonic phrase.
To use a specific mnemonic phrase:
2019-08-02 13:58:12 +00:00
```sh
2020-01-16 14:14:08 +00:00
./emu.py --mnemonic "such deposit very security much theme..."
2019-08-02 13:58:12 +00:00
```
2020-01-16 14:14:08 +00:00
When using Shamir shares, repeat the `--mnemonic` option:
2019-08-02 13:58:12 +00:00
```sh
2020-01-16 14:14:08 +00:00
./emu.py --mnemonic "your first share" --mnemonic "your second share" ...
2019-08-02 13:58:12 +00:00
```
2020-01-16 14:14:08 +00:00
To use the "all all all" seed defined in [SLIP-14 ](https://github.com/satoshilabs/slips/blob/master/slip-0014.md ):
2019-08-02 13:58:12 +00:00
```sh
2020-01-16 14:14:08 +00:00
./emu.py --slip0014
2019-08-02 13:58:12 +00:00
```
### Storage and Profiles
2020-07-02 13:04:06 +00:00
Internal Trezor's storage is emulated and stored in the `/var/tmp/trezor.flash` file by
2020-01-16 14:14:08 +00:00
default. Deleting this file is similar to calling _wipe device_ . You can also find
2020-01-16 16:17:41 +00:00
`/var/tmp/trezor.sdcard` for SD card.
2019-08-02 13:58:12 +00:00
2020-01-16 14:14:08 +00:00
You can specify a different location for the storage and log files via the `-p` /
`--profile` option:
2019-08-02 13:58:12 +00:00
```sh
2020-01-16 14:14:08 +00:00
./emu.py -p foobar
2019-08-02 13:58:12 +00:00
```
2020-01-16 14:14:08 +00:00
This will create a profile directory in your home `~/.trezoremu/foobar` containing
emulator run files. Alternatively you can set a full path like so:
2019-08-02 13:58:12 +00:00
```sh
2020-01-16 14:14:08 +00:00
./emu.py -p /var/tmp/foobar
2019-08-02 13:58:12 +00:00
```
2020-01-16 14:14:08 +00:00
You can also set a full profile path to `TREZOR_PROFILE_DIR` environment variable.
2019-08-02 13:58:12 +00:00
2020-01-16 14:14:08 +00:00
Specifying `-t` / `--temporary-profile` will start the emulator in a clean temporary
profile that will be erased when the emulator stops. This is useful, e.g., for tests.
2019-08-02 13:58:12 +00:00
2020-01-16 16:17:41 +00:00
### Logging
By default, emulator output goes to stdout. When silenced with `--quiet` , it is
redirected to `${TREZOR_PROFILE_DIR}/trezor.log` . You can specify an alternate output
file with `--output` .
2020-01-16 14:14:08 +00:00
### Running subcommands with the emulator
2019-08-02 13:58:12 +00:00
2020-01-16 14:14:08 +00:00
In scripts, it is often necessary to start the emulator, run a commmand while it is
available, and then stop it. The following command runs the device test suite using the
emulator:
2019-08-02 13:58:12 +00:00
2020-01-16 14:14:08 +00:00
```sh
./emu.py --command pytest ../tests/device_tests
```
### Profiling support
2019-08-02 13:58:12 +00:00
2020-01-16 14:14:08 +00:00
Run `./emu.py --profiling` , or set environment variable `TREZOR_PROFILING=1` , to run the
emulator with a profiling wrapper that generates statistics of executed lines.
2019-08-02 13:58:12 +00:00
2020-01-16 14:14:08 +00:00
### Memory statistics
2019-08-19 15:02:05 +00:00
2020-01-16 14:14:08 +00:00
Run `./emu.py --log-memory` , or set environment variable `TREZOR_LOG_MEMORY=1` , to dump
memory usage information after each workflow task is finished.
### Run in gdb
Running `./emu.py --debugger` runs emulator inside gdb/lldb.
### Watch for file changes
Running `./emu.py --watch` watches for file changes and reloads the emulator if any
occur. Note that this does not do rebuild, i.e. this works for MicroPython code (which
is interpreted) but if you make C changes, you need to rebuild yourself.
### Print screen
2019-08-19 15:02:05 +00:00
2020-01-16 14:14:08 +00:00
Press `p` on your keyboard to capture emulator's screen. You will find a png screenshot
in the `src` directory.
2019-08-19 15:02:05 +00:00
2020-01-16 14:14:08 +00:00
### Disable animation
2019-08-19 15:02:05 +00:00
2020-01-16 14:14:08 +00:00
Run `./emu.py --disable-animation` , or set environment variable
`TREZOR_DISABLE_ANIMATION=1` to disable all animations.
