Skip to content

User Guide

Attila Greguss edited this page Aug 20, 2018 · 2 revisions

iMirror Usage Guide

  1. Usage without Alexa Device SDK: Walk up to the mirror and the default widgets show up for a minute.
  2. Usage with Alexa Device SDK: in addition to the first paragraph, you can control the iMirror via Alexa through iMirrors API. See the Alexa Skills Usage Guide after installation of the Alexa Device SDK.

Alternatively, you can utliize the API yourself described at the end of the main Readme File.

Issue: The get the sensor reading from a thunderboard sensor you may need to reset the board.

1. Customization

Non-customizable features and behaviours

If a person is walking up to the mirror without previous interaction in a given time, the preferred widgets show up on the screen. By default they are: Clock, Weather, News and Guide. Also, if there is more than one widget on the same position, the one with the highest number is shown on an event when all widgets are shown.

if a person walking up to the mirror with previous interaction (calls through the API, meaning Alexa commands) in the given timeframe the mirror only register that threr is motion, but does not act on it.

If there is no user action (motion or API calls) in a given timeframe, the iMirror turns every widgets off. Notifications and the Conversations widget are exluded from this, as they don't count as human interaction.

  • Notifications appear on the iMirror and disappear after a given time. Implemented notifications:
    • if temperature goes above 30 celsius, showing it one time
    • If CO2 Readings are above recommended level, showing every 10 minutes
    • if CO2 Reading are critical, showing every minute
  • Implemented Alexa Skills responses showing up on the mirror and disappear after a given time in the Conversation widget

Customizable Behaviours

After the first run a config.cfg file is created what stores information about timeframes, widget locations and preferences.

Example of the default config:

[Mirror]
mirrorttl = 60
notifttl = 10
alexattl = 10
; ttl values are in seconds. = 

[WIDGET_POSITIONS]
news = BOTRIGHT
clock = TOPRIGHT
weather = TOPLEFT
sensors = BOTRIGHT
guide = BOTLEFT
alexa = BOTLEFT
notif = MID
; avaliable values are: topleft,topmid topright, midleft, mid, midright 
botleft, botmid, botright = 

[WIDGET_WEIGHTS]
guide = 1.2
alexa = -9999999
notif = -9999999
weather = 1.5
clock = 1.4
news = 1.3
sensors = 1.1

Description of the config:

  • MirrorTTL: means how long the iMirror stays on without human interaction after its been used. In seconds.

  • NotifTTL: means how long Notifications stay on the screen. In Seconds

  • AlexaTTL: means how long Alexa conversation responses stay on the screen. In Seconds

  • [WIDGET_POSITIONS] section: Stores the default positions of the widgets. can be changed in the config or through the API.

  • [WIDGET_WEIGHTS] section: Meant to be changed by behaviour. If a user explicitly turns a widget on/off, its number gets incemented/decremented respectively.

    If there is more than one widget on the same position, the one with the highest number is shown on an event when all widgets are shown. Conversation and Notification widgets are excluded from this.