README
¶
Smart mirror platform written in Go leveraging Yaegi.
Table of Contents
Requirements
Chrome
Chrome or Chromium must be installed. The version must be greater or equal to 70. If looking glass cannot find
Chrome, use the LORCACHROME environment variable to force the location of your installation.
Install
On a fresh install of Raspberry Pi OS Lite, run the following command:
bash -c "$(curl -fsSL https://git.io/looking_glass)"
Usage
Run
Runs looking glass using the specified configuration and modules path.
glass run -c /path/to/config.yaml -m /path/to/modules
Run Options
--secrets FILE, -s FILE, $SECRETS (Optional)
The path to the YAML secrets file to hold sensitive configuration values. Secrets can be accessed in the configuration using Go template syntax using the ".Secrets" prefix.
--config FILE, -c FILE, $CONFIG (Required)
The path to the YAML configuration file for looking-glass which includes module configuration.
This file will be parsed using Go template syntax.
--modules PATH, -m PATH, $MODULES (Required)
The path to the modules. Module must be located under a src folder in the modules path.
The application will need to be able to create files and folders in this path.
--log.format FORMAT, $LOG_FORMAT (Default: "logfmt")
Specify the format of logs. Supported formats: 'logfmt', 'json', 'console'.
--log.level LEVEL, $LOG_LEVEL (Default: "info")
Specify the log level. Supported levels: 'debug', 'info', 'warn', 'error', 'crit'.
Configuration
ui:
width: 640
height: 480
fullscreen: true
customCss:
- path/to/custom.css
modules:
- name: simple-clock
path: github.com/glasslabs/clock
version: latest
position: top:right
- name: simple-weather
path: weather
position: top:left
config:
locationId: 996506
appId: {{ .Secrets.weather.appId }}
units: metric
The module configuration can contain secrets from the secrets YAML prefixed with .Secrets
as shown in the example above.
Configuration Options
ui.width
The width of the chrome window.
ui.height
The height of the chrome window.
ui.fullscreen
If the chrome window should start fullscreen.
ui.customCSS
A list of custom css files to load. These can be used to customise the layout of looking glass.
modules.[].name
The name of the module. This name must be unique. This is used as the ID of the module HTML wrapper.
modules.[].path
The module repository or path of the module under the modules path. If the version of module is set, looking glass will attempt download the module and manage its versions, otherwise it will assume the provided path exists.
modules.[].version
The version or branch of the module to download. This can also be latest in which case the latest version will be
downloaded.
modules.[].position
The position of the module.
modules.[].config
The configuration that will be passed to the module.
Configuration Variables
The configuration file will be parsed using Go template syntax. The available variables are:
Secrets
The secrets in the case they appear in the secrets file.
Env
The environment variables available when running looking-glass.
Modules
You can discover modules on GitHub using GitHub Search.
Package Naming
If your module uses a hyphen, which is not supported by Go, it will be assumed that the package name is the
last path of the hyphenated name (e.g. looking-glass would result in a package name glass). If this is not
the case for your module, the Package should be set in the module configuration to the correct package name and
should be documented in your module.
Development
To make your module discoverable on GitHub, add the topics looking-glass and module.
Modules are parsed in yaegi and must expose two functions to be loaded:
NewConfig
NewConfig exposes your configuration structure to looking glass. The function must return
a single structure with default values set. The YAML configuration will be decoded into
the returned structure, so it should contain yaml tags for the configuration to be decoded
properly.
func NewConfig() *Config
An example configuration would look as follows:
// Config is the module configuration.
type Config struct {
TimeFormat string `yaml:"timeFormat"`
DateFormat string `yaml:"dateFormat"`
Timezone string `yaml:"timezone"`
}
New
New creates an instance of your module. It must return an io.Closer and an error.
The function takes a context.Context, the configuration structure returned by NewConfig,
Info and UI objects.
func New(ctx context.Context, cfg *Config, info types.Info, ui types.UI) (io.Closer, error)
Dependencies
All dependencies must be vendored except for github.com/glasslabs/looking-glass/module/types.
If you still wish to use Go Modules for dependency management, you should run go mod vendor to
vendor your dependencies and commit your vendor/modules.txt to git.
More information about vendoring can be found in the Go Module Reference.
TODO
This is very much a work in progress and under active development. The immediate list of things to do is below:
- Localisation
- Testing Framework for Modules
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ParseSecrets ¶
ParseSecrets parses secrets from in.
Types ¶
type Config ¶
type Config struct {
UI UIConfig `yaml:"ui"`
Modules []module.Descriptor `yaml:"modules"`
}
Config contains the main configuration.
func ParseConfig ¶
ParseConfig parses configuration from in.
type UI ¶
type UI struct {
// contains filtered or unexported fields
}
UI implements a ui manager.
type UIConfig ¶
type UIConfig struct {
Width int `yaml:"width"`
Height int `yaml:"height"`
Fullscreen bool `yaml:"fullscreen"`
CustomCSS []string `yaml:"customCss"`
}
UIConfig contains configuration for the UI.
type UIContext ¶
type UIContext struct {
// contains filtered or unexported fields
}
UIContext implements a UI in context of a module element.
func NewUIContext ¶
NewUIContext returns a ui with the context of a module.
Source Files
Directories