search

dgonano / MMM-AlexaPi

Magic Mirror module for the AlexaPi
20 stars 2 forks source link

readme

Module: MMM-AlexaPi

The MMM-AlexaPi module is used to integrate with AlexaPi This module indicates the status of AlexaPi. Possible status' include,

Using the module

Clone the repo in the modules folder: git clone https://github.com/dgonano/MMM-AlexaPi.git

Add it to the modules array in the config/config.js file:

modules: [
    {
        module: 'MMM-AlexaPi',
        position: 'lower_third',
        config: {
            // The config property is optional.
            // If no config is set, defualt values are used
            // See 'Configuration options' for more information.
        }
    }
]

Note: When installing AlexaPi be sure to set the device to magicmirror and not raspberrypi (or other device)

Configuration options

The following properties can be configured:

Option Description
alexaTimeout The time is milliseconds a status will be displayed before automatically reverting to 'idle'

Default value: 30000 (30 Seconds)
alexaHBTimeout The time in milliseconds a heartbeat needs to be recieved from AlexaPi before declaring no_connection

Default value: 10000 (10 Seconds)