Skip to content

Latest commit

 

History

History
227 lines (206 loc) · 7.08 KB

WATCHFACE.md

File metadata and controls

227 lines (206 loc) · 7.08 KB
Raw

watchface.tar.gz

This compressed file contains all file as a package to download and run a watchface. All image and fontfiles must be included here. A minimum watchface.tar.gz includes a watchface_theme.json. From here all fancy things begins.

watchface_theme.json overview

file format

{
	"api_level": 2,
	"dial": {
		"enable": true,
		"x_offset": 0,
		"y_offset": 0
	},
	...
	"label": [
		...
	],
	"image": [
		...
	]
}

dial, hour, min, sec, hour_shadow, min_shadow and sec_shadow

A dial, hour and so on has the following three options:

enable: true or false x_offset: x position on the screen in pixel. Top is 0. y_offset: y position on the screen in pixel. Left is 0.

Remember, a center to the screen and the rotation center is in the middle of the image.

"dial": {
	"enable": true,
	"x_offset": 0,
	"y_offset": 0
},
"hour": {
	"enable": true,
	"x_offset": 0,
	"y_offset": 0
},
...

The image name convention is watchface_dial.png, watchface_hour.png and so on and will automatically loaded if enabled. No entry mean disabled.

label

A label entry looks like this:

"label": [
	{
		"enable": true,
		"type": "date",
		"label": "%H %M",
		"font": "LCD",
		"font_color": "#304e65",
		"font_size": 48,
		"align": "center",
		"hide_interval": -1,
		"x_offset": 38,
		"y_offset": 118,
		"x_size": 134,
		"y_size": 40
	},
	{
		"enable": true,
		"type": "date",
		"label": "%H:%M",
		"font": "LCD",
		"font_color": "#304e65",
		"font_size": 48,
		"align": "center",
		"hide_interval": 1,
		"x_offset": 38,
		"y_offset": 118,
		"x_size": 134,
		"y_size": 40
	},
	{
	....
	}
]
option value type description
enable bool true, false or expression
type string see label types
label string label string
font string font name or a font filename. the font filename ends with .font. see font types and size.
font_color string font color like "#808080" for pue grey, format is "#rrggbb" in hex
font_size string font size in pixel, see font types and size
align string center, left and right
hide_interval int 0 mean not used. positive values hide this label in a show/hide interval. and negative values is hide/show.
x_offset int x position on the screen in pixel. Top is 0.
y_offset int y position on the screen in pixel. Left is 0.
x_size int x container size on the screen in pixel.
y_size int y container size on the screen in pixel.

The example above schow how a blinking time works.

label types

label type description
text a raw text.
date an information related to date/time. See strftime function for format.
battery_percent the battery percent as an integer. Example: "%d%%" for 87%.
battery_voltage the battery voltage, as a float. Example: "%.2fV" for 1.34V.
bluetooth_messages the number of messages, as an integer. Example: "msg: %d" for msg: 2
steps the number of steps, as an integer.

font type and size

Available font are: Ubuntu, Montserrat, LCD. Available font sizes are: 12 (U,L), 14 (M), 16 (U,M,L), 22 (M), 28 (M), 32 (U,M,L), 48 (U,L), 72 (U,L). On api_level 3 it is possible to load a font on runtime from spiffs. As example: lcd.font loads a font file from spiffs. location is: /spiffs/watchface/lcd.font here is a manual how create your own font file

The Montserrat font allow access to FontAwesome symbols as presented in the official documentation.

image

A image entry looks like this:

"image": [
	{
		"enable": true,
		"type": "time_sec",
		"file": "klingon_yellow.png",
		"hide_interval": 0,
		"rotation_range": 359,
		"rotation_start": 0,
		"rotation_x_origin": 8,
		"rotation_y_origin": 26,
		"x_offset": 135,
		"y_offset": 115,
		"x_size": 52,
		"y_size": 52
	},
	{
		"enable": true,
		"type": "time_sec",
		"file": "klingon_red.png",
		"hide_interval": 0,
		"rotation_range": 359,
		"rotation_start": 0,
		"rotation_x_origin": 8,
		"rotation_y_origin": 26,
		"x_offset": 165,
		"y_offset": 105,
		"x_size": 52,
		"y_size": 52
	}
]
option value type description
enable bool true, false or expression
type string see image types
file string image filename. Example: "klingon_red.png" loads a png from spiffs on location /spiffs/watchface/klingon_red.png.
hide_interval int 0 mean not used. positive values hide this label in a show/hide interval. negative values in a hide/show interval.
rotation_range int rotation range in degree.
rotation_start int rotation start angle in degree.
rotation_x_origin int x origin for rotation center in pixel. top is 0.
rotation_y_origin int y origin for rotation center in pixel. left is 0.
x_offset int x position on the screen in pixel. Top is 0.
y_offset int y position on the screen in pixel. Left is 0.
x_size int x container size on the screen in pixel.
y_size int y container size on the screen in pixel.

image types

image type description
image a raw image without interaction.
battery_percent rotation_range divide by battery percent and add to rotation_start, battery range is 0-100.
battery_voltage rotation_range divide by battery voltage and add to rotation_start. voltage range is 0-5.
time_hour rotation_range divide by current hour and add to rotation_start. hour range is 0-23
time_min rotation_range divide by current min and add to rotation_start. min range is 0-59
time_sec rotation_range divide by current min and add to rotation_start. hour range is 0-59

Expressions

Some mathematical or logical expressions can be use to control display of the watchface elements. Full syntax is available at TinyExpr main site.

Variables

Variables available in this context are described in the following table.

Name Description
gps GPS status (disabled=0, enabled(no fix)=1, enabled+fix=2)
ble Bluetooth status (disabled=0, enabled+disconnected=1, enabled+connected=2)
sound_volume Sound volume
sound_enabled Sound enable = 1, else 0
alarm Alarm (No alarm = 0, Alarm set = 1)
wifi Wifi status (disabled=0, enabled+disconnected=1, enabled+connected=2)
battery_percent Battery percent (range is 0-100)
battery_voltage Battery voltage (voltage range is 0-5)
bluetooth_messages Number of messages (bluetooth_messages())
steps Number of steps (steps())
time_hour Hour of the current time
time_min Minutes of the current time
time_sec Seconds of the current time

Note: expressions are computed in double.

Examples

Display GPS symbol when GPS is enabled.

    {
      "enable": "gps > 0",
      "type": "text",
      "label": "\uF124",
      "font": "Montserrat",
      "font_color": "#6c680d",
      "align": "center",
      "font_size": 16,
      "x_offset": 206,
      "y_offset": 20,
      "x_size": 24,
      "y_size": 20
    },