Skip to content

Sen5or/UI

Repository files navigation

Smart Mirror UI

With gesture recognition, voice recognition, and dynamic module manipulation.

Based on the MagicMirror² project at https://github.com/MichMich/MagicMirror

Manual Installation

  1. Download and install the latest Node.js version.

  2. sudo npm install -g snyk

  3. sudo npm install -g electron

  4. Clone the repository and check out the beta branch: git clone https://github.com/Sen5or/UI.git

  5. Enter the repository: cd ~/UI

  6. Install and run the app: npm install && npm start

Configuration

  1. Duplicate config/config.js.sample to config/config.js.
  2. Modify your required settings.

The following properties can be configured:

Option Description
port The port on which the Smart Mirror server will run on. The default value is 8080.
kioskmode This allows Smart Mirror to run in Kiosk Mode. It protects from other programs popping on top of your screen. The default value is false
language The language of the interface. (Note: Not all elements will be localized.) Possible values are en, nl, ru, fr, etc., but the default value is en.
timeFormat The form of time notation that will be used. Possible values are 12 or 24. The default is 24.
units The units that will be used in the default weather modules. Possible values are metric or imperial. The default is metric.
modules An array of active modules. The array must contain objects. See the next table below for more information.

Module configuration:

Option Description
module The name of the module. This can also contain the subfolder. Valid examples include clock, default/calendar and custommodules/mymodule.
position The location of the module in which the module will be loaded. Possible values are top_ bar, top_left, top_center, top_right, upper_third, middle_center, lower_third, bottom_left, bottom_center, bottom_right, bottom_bar, fullscreen_above, and fullscreen_below. This field is optional but most modules require this field to set. Check the documentation of the module for more information. Multiple modules with the same position will be ordered based on the order in the configuration file.
classes Additional classes which are passed to the module. The field is optional.
header To display a header text above the module, add the header property. This field is optional.
config An object with the module configuration properties. Check the documentation of the module for more information. This field is optional, unless the module requires extra configuration.

Modules

The following modules are installed by default.

For more available modules, check out out the wiki page: MagicMirror² Modules. If you want to build your own modules, check out the MagicMirror² Module Development Documentation and don't forget to add it to the wiki and the forum!

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors