matejcik
4 years ago
parent
8c75c94125
commit
05a1d6f771
@ -0,0 +1,50 @@
|
||||
import trezor.messages.DebugLinkShowTextStyle as S
|
||||
from trezor import ui, wire
|
||||
from trezor.messages.DebugLinkShowText import DebugLinkShowText
|
||||
from trezor.messages.Success import Success
|
||||
from trezor.ui import style, text
|
||||
from trezor.ui.text import Text
|
||||
|
||||
from apps.common.confirm import confirm
|
||||
|
||||
STYLES = {
|
||||
S.NORMAL: ui.NORMAL,
|
||||
S.BOLD: ui.BOLD,
|
||||
S.MONO: ui.MONO,
|
||||
S.MONO_BOLD: ui.MONO_BOLD,
|
||||
S.BR: text.BR,
|
||||
S.BR_HALF: text.BR_HALF,
|
||||
}
|
||||
|
||||
|
||||
async def show_text(ctx: wire.Context, msg: DebugLinkShowText) -> Success:
|
||||
if msg.header_icon is not None:
|
||||
icon_name = "ICON_" + msg.header_icon
|
||||
icon = getattr(style, icon_name)
|
||||
if not isinstance(icon, str):
|
||||
raise wire.DataError("Invalid icon name: {}".format(msg.header_icon))
|
||||
else:
|
||||
icon = style.ICON_DEFAULT
|
||||
|
||||
if msg.icon_color is not None:
|
||||
color = getattr(style, msg.icon_color)
|
||||
if not isinstance(color, int):
|
||||
raise wire.DataError("Invalid color name: {}".format(msg.icon_color))
|
||||
else:
|
||||
color = style.ORANGE_ICON
|
||||
|
||||
dlg = Text(msg.header_text, icon, color, new_lines=False)
|
||||
for item in msg.body_text:
|
||||
if item.style in STYLES:
|
||||
dlg.content.append(STYLES[item.style])
|
||||
elif item.style == S.SET_COLOR:
|
||||
color = getattr(style, item.content)
|
||||
if not isinstance(color, int):
|
||||
raise wire.DataError("Invalid color name: {}".format(item.content))
|
||||
dlg.content.append(color)
|
||||
|
||||
elif item.content is not None:
|
||||
dlg.content.append(item.content)
|
||||
|
||||
await confirm(ctx, dlg)
|
||||
return Success("text shown")
|
||||
@ -0,0 +1,37 @@
|
||||
# Automatically generated by pb2py
|
||||
# fmt: off
|
||||
import protobuf as p
|
||||
|
||||
from .DebugLinkShowTextItem import DebugLinkShowTextItem
|
||||
|
||||
if __debug__:
|
||||
try:
|
||||
from typing import Dict, List # noqa: F401
|
||||
from typing_extensions import Literal # noqa: F401
|
||||
except ImportError:
|
||||
pass
|
||||
|
||||
|
||||
class DebugLinkShowText(p.MessageType):
|
||||
MESSAGE_WIRE_TYPE = 9004
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
header_text: str = None,
|
||||
body_text: List[DebugLinkShowTextItem] = None,
|
||||
header_icon: str = None,
|
||||
icon_color: str = None,
|
||||
) -> None:
|
||||
self.header_text = header_text
|
||||
self.body_text = body_text if body_text is not None else []
|
||||
self.header_icon = header_icon
|
||||
self.icon_color = icon_color
|
||||
|
||||
@classmethod
|
||||
def get_fields(cls) -> Dict:
|
||||
return {
|
||||
1: ('header_text', p.UnicodeType, 0),
|
||||
2: ('body_text', DebugLinkShowTextItem, p.FLAG_REPEATED),
|
||||
3: ('header_icon', p.UnicodeType, 0),
|
||||
4: ('icon_color', p.UnicodeType, 0),
|
||||
}
|
||||
@ -0,0 +1,29 @@
|
||||
# Automatically generated by pb2py
|
||||
# fmt: off
|
||||
import protobuf as p
|
||||
|
||||
if __debug__:
|
||||
try:
|
||||
from typing import Dict, List # noqa: F401
|
||||
from typing_extensions import Literal # noqa: F401
|
||||
EnumTypeDebugLinkShowTextStyle = Literal[0, 1, 2, 3, 4, 5, 6]
|
||||
except ImportError:
|
||||
pass
|
||||
|
||||
|
||||
class DebugLinkShowTextItem(p.MessageType):
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
style: EnumTypeDebugLinkShowTextStyle = None,
|
||||
content: str = None,
|
||||
) -> None:
|
||||
self.style = style
|
||||
self.content = content
|
||||
|
||||
@classmethod
|
||||
def get_fields(cls) -> Dict:
|
||||
return {
|
||||
1: ('style', p.EnumType("DebugLinkShowTextStyle", (0, 1, 2, 3, 4, 5, 6)), 0),
|
||||
2: ('content', p.UnicodeType, 0),
|
||||
}
|
||||
@ -0,0 +1,12 @@
|
||||
# Automatically generated by pb2py
|
||||
# fmt: off
|
||||
if False:
|
||||
from typing_extensions import Literal
|
||||
|
||||
NORMAL = 0 # type: Literal[0]
|
||||
BOLD = 1 # type: Literal[1]
|
||||
MONO = 2 # type: Literal[2]
|
||||
MONO_BOLD = 3 # type: Literal[3]
|
||||
BR = 4 # type: Literal[4]
|
||||
BR_HALF = 5 # type: Literal[5]
|
||||
SET_COLOR = 6 # type: Literal[6]
|
||||
|
After Width: | Height: | Size: 7.2 KiB |
|
After Width: | Height: | Size: 5.8 KiB |
|
After Width: | Height: | Size: 7.3 KiB |
|
After Width: | Height: | Size: 8.0 KiB |
|
After Width: | Height: | Size: 5.8 KiB |
|
After Width: | Height: | Size: 7.3 KiB |
|
After Width: | Height: | Size: 7.2 KiB |
@ -0,0 +1,138 @@
|
||||
# Displaying text screens on Trezor T
|
||||
|
||||
## Requirements
|
||||
|
||||
For this feature, you will need a debug-enabled firmware for Trezor T. Usually that
|
||||
will be the emulator.
|
||||
|
||||
You will also need `trezorctl` 0.12 or later. Best bet is to run the version from github
|
||||
master.
|
||||
|
||||
## Trezor T text capabilities
|
||||
|
||||
The Trezor T screen has a _header_, with an icon and text. Below it is _body_, which
|
||||
can fit up to 5 lines of text.
|
||||
|
||||
Text can be in one of several colors, and in one of four styles: NORMAL, BOLD, MONO
|
||||
and MONO_BOLD.
|
||||
|
||||
It is possible to have multiple styles on the same line, but different styles must be
|
||||
separated by a space.
|
||||
|
||||
I.e., this works fine:
|
||||
|
||||
> This word is **bold** and this is `monospaced`.
|
||||
|
||||
This will not work:
|
||||
|
||||
> Em**bold**ened middle, mono`space`d middle.
|
||||
|
||||
A line that is too long to fit on screen will automatically break, using a hyphen (`-`)
|
||||
character. This is usually undesirable. Instead, a manual line-break should be inserted
|
||||
in the appropriate place.
|
||||
|
||||
## Command line syntax
|
||||
|
||||
The most basic way to put words on screen is this:
|
||||
|
||||
```sh
|
||||
trezorctl debug show-text "My hovercraft is full of eels, call the porter, there is a frog in my bidet."
|
||||
```
|
||||
|
||||
The above command will show:
|
||||
|
||||
|
||||
|
||||
Notice the "quotes" around the text. The whole body text must be enquoted.
|
||||
|
||||
To use quotes inside the text, prefix them with backslashes `\`:
|
||||
|
||||
```sh
|
||||
trezorctl debug show-text "My \"hovercraft\" is full of eels."
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Line breaks
|
||||
|
||||
Let's insert some line breaks. Do that by placing `@@BR` in the appropriate place
|
||||
in the text:
|
||||
|
||||
```sh
|
||||
trezorctl debug show-text "My hovercraft is full of @@BR eels, call the porter, @@BR there is a frog in my @@BR bidet."
|
||||
```
|
||||
|
||||
|
||||
|
||||
Better!
|
||||
|
||||
### Text styles
|
||||
|
||||
Now let's add some style. Use `@@BOLD` to start printing in bold. Use `@@NORMAL`
|
||||
to go back to normal text. `@@MONO` and `@@MONO_BOLD` works similarly.
|
||||
|
||||
```sh
|
||||
trezorctl debug show-text "My hovercraft is @@BOLD full of @@BR eels. @@NORMAL Call the porter, @@BR there is a @@MONO frog @@NORMAL in my @@BR bidet."
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Line spacing
|
||||
|
||||
Adding another `@@BR` after a `@@BR` will leave one line empty -- just like pressing
|
||||
\<Enter\> twice.
|
||||
|
||||
If you don't want a full empty line, you can make a half-break with `@@BR_HALF`.
|
||||
|
||||
```sh
|
||||
trezorctl debug show-text "Line one. @@BR @@BR Line two. @@BR @@BR_HALF Line three."
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### Text colors
|
||||
|
||||
To switch to one of the [available colors](../../core/src/trezor/ui/style.py#L14-L47),
|
||||
use the color name prefixed with `%%`: e.g., `%%RED`, `%%LIGHT_BLUE`...
|
||||
|
||||
To switch back to the default color, you can use `%%FG`:
|
||||
|
||||
```sh
|
||||
trezorctl debug show-text "My %%RED hovercraft is @@BOLD full %%GREEN of @@BR eels. @@NORMAL Call %%ORANGE the %%FG porter."
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Headers
|
||||
|
||||
The default header says "Showing text" with an orange gear icon. It is possible to
|
||||
change all of that.
|
||||
|
||||
To change the text, use `-h` option:
|
||||
|
||||
```sh
|
||||
trezorctl debug show-text -h "Hello world" "My hovercraft is full."
|
||||
```
|
||||
|
||||
To change the icon, you can pick [an icon name from here](../../core/src/trezor/ui/style.py#L50-L70) and specify it with the `-i` option:
|
||||
|
||||
```sh
|
||||
trezorctl debug show-text -i RECEIVE "My hovercraft is full."
|
||||
```
|
||||
|
||||
The icons are defined as shapes, and you can specify a custom color [from the list](../../core/src/trezor/ui/style.py#L14-L47) with the `-c` option:
|
||||
|
||||
```sh
|
||||
trezorctl debug show-text -c RED "My hovercraft is full."
|
||||
```
|
||||
|
||||
### Putting it all together
|
||||
|
||||
Here is how to reproduce the confirmation screen after the wallet is created:
|
||||
|
||||
```sh
|
||||
trezorctl debug show-text -h "Success" -i CONFIRM -c GREEN "@@BOLD New wallet created @@BR successfully! @@BR @@BR_HALF @@NORMAL You should back up your @@BR new wallet right now."
|
||||
```
|
||||
|
||||
|
||||
@ -0,0 +1,73 @@
|
||||
# This file is part of the Trezor project.
|
||||
#
|
||||
# Copyright (C) 2012-2019 SatoshiLabs and contributors
|
||||
#
|
||||
# This library is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU Lesser General Public License version 3
|
||||
# as published by the Free Software Foundation.
|
||||
#
|
||||
# This library is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU Lesser General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the License along with this library.
|
||||
# If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.
|
||||
|
||||
import click
|
||||
|
||||
from .. import debuglink
|
||||
from ..messages import DebugLinkShowTextStyle as S
|
||||
|
||||
|
||||
@click.group(name="debug")
|
||||
def cli():
|
||||
"""Miscellaneous debug features."""
|
||||
|
||||
|
||||
STYLES = {
|
||||
"@@NORMAL": S.NORMAL,
|
||||
"@@BOLD": S.BOLD,
|
||||
"@@MONO": S.MONO,
|
||||
"@@MONO_BOLD": S.MONO_BOLD,
|
||||
"@@BR": S.BR,
|
||||
"@@BR_HALF": S.BR_HALF,
|
||||
}
|
||||
|
||||
|
||||
@cli.command()
|
||||
@click.option("-i", "--icon", help="Header icon name")
|
||||
@click.option("-c", "--color", help="Header icon color")
|
||||
@click.option("-h", "--header", help="Header text", default="Showing text")
|
||||
@click.argument("body")
|
||||
@click.pass_obj
|
||||
def show_text(connect, icon, color, header, body):
|
||||
"""Show text on Trezor display.
|
||||
|
||||
For usage instructions, see:
|
||||
https://github.com/trezor/trezor-firmware/blob/master/docs/python/show-text.md
|
||||
"""
|
||||
body = body.split()
|
||||
body_text = []
|
||||
words = []
|
||||
|
||||
def _flush():
|
||||
if words:
|
||||
body_text.append((None, " ".join(words)))
|
||||
words.clear()
|
||||
|
||||
for word in body:
|
||||
if word in STYLES:
|
||||
_flush()
|
||||
body_text.append((STYLES[word], None))
|
||||
elif word.startswith("%%"):
|
||||
_flush()
|
||||
body_text.append((S.SET_COLOR, word[2:]))
|
||||
else:
|
||||
words.append(word)
|
||||
|
||||
_flush()
|
||||
|
||||
return debuglink.show_text(
|
||||
connect(), header, body_text, icon=icon, icon_color=color
|
||||
)
|
||||
@ -0,0 +1,37 @@
|
||||
# Automatically generated by pb2py
|
||||
# fmt: off
|
||||
from .. import protobuf as p
|
||||
|
||||
from .DebugLinkShowTextItem import DebugLinkShowTextItem
|
||||
|
||||
if __debug__:
|
||||
try:
|
||||
from typing import Dict, List # noqa: F401
|
||||
from typing_extensions import Literal # noqa: F401
|
||||
except ImportError:
|
||||
pass
|
||||
|
||||
|
||||
class DebugLinkShowText(p.MessageType):
|
||||
MESSAGE_WIRE_TYPE = 9004
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
header_text: str = None,
|
||||
body_text: List[DebugLinkShowTextItem] = None,
|
||||
header_icon: str = None,
|
||||
icon_color: str = None,
|
||||
) -> None:
|
||||
self.header_text = header_text
|
||||
self.body_text = body_text if body_text is not None else []
|
||||
self.header_icon = header_icon
|
||||
self.icon_color = icon_color
|
||||
|
||||
@classmethod
|
||||
def get_fields(cls) -> Dict:
|
||||
return {
|
||||
1: ('header_text', p.UnicodeType, 0),
|
||||
2: ('body_text', DebugLinkShowTextItem, p.FLAG_REPEATED),
|
||||
3: ('header_icon', p.UnicodeType, 0),
|
||||
4: ('icon_color', p.UnicodeType, 0),
|
||||
}
|
||||
@ -0,0 +1,29 @@
|
||||
# Automatically generated by pb2py
|
||||
# fmt: off
|
||||
from .. import protobuf as p
|
||||
|
||||
if __debug__:
|
||||
try:
|
||||
from typing import Dict, List # noqa: F401
|
||||
from typing_extensions import Literal # noqa: F401
|
||||
EnumTypeDebugLinkShowTextStyle = Literal[0, 1, 2, 3, 4, 5, 6]
|
||||
except ImportError:
|
||||
pass
|
||||
|
||||
|
||||
class DebugLinkShowTextItem(p.MessageType):
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
style: EnumTypeDebugLinkShowTextStyle = None,
|
||||
content: str = None,
|
||||
) -> None:
|
||||
self.style = style
|
||||
self.content = content
|
||||
|
||||
@classmethod
|
||||
def get_fields(cls) -> Dict:
|
||||
return {
|
||||
1: ('style', p.EnumType("DebugLinkShowTextStyle", (0, 1, 2, 3, 4, 5, 6)), 0),
|
||||
2: ('content', p.UnicodeType, 0),
|
||||
}
|
||||
@ -0,0 +1,12 @@
|
||||
# Automatically generated by pb2py
|
||||
# fmt: off
|
||||
if False:
|
||||
from typing_extensions import Literal
|
||||
|
||||
NORMAL = 0 # type: Literal[0]
|
||||
BOLD = 1 # type: Literal[1]
|
||||
MONO = 2 # type: Literal[2]
|
||||
MONO_BOLD = 3 # type: Literal[3]
|
||||
BR = 4 # type: Literal[4]
|
||||
BR_HALF = 5 # type: Literal[5]
|
||||
SET_COLOR = 6 # type: Literal[6]
|
||||
Loading…
Reference in new issue