Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kalliope-project/MMM-kalliope
Magic Mirror module for Kalliope
https://github.com/kalliope-project/MMM-kalliope
Last synced: 3 months ago
JSON representation
Magic Mirror module for Kalliope
- Host: GitHub
- URL: https://github.com/kalliope-project/MMM-kalliope
- Owner: kalliope-project
- Created: 2018-02-18T10:14:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-19T12:42:06.000Z (8 months ago)
- Last Synced: 2024-06-29T10:32:55.142Z (5 months ago)
- Language: JavaScript
- Size: 585 KB
- Stars: 8
- Watchers: 5
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-mmm - **MMM-Kalliope**
README
# MMM-kalliope
Module to bind [Kalliope](https://github.com/kalliope-project/kalliope) with your Magic Mirror.
This module allow you to:
- show what Kalliope say on the screen
- control your Magic Mirror by sending notification to other active modules
> **Note:** On Kalliope, [a neuron is available](https://github.com/kalliope-project/kalliope_neuron_magic_mirror) to talk with this module directly.
[Video demo with sound here](https://youtu.be/QHwctPbJ2ZY)
## Installation
Clone this repo into `~/MagicMirror/modules` directory.
Configure your `~/MagicMirror/config/config.js`:
```js
{
module: "MMM-kalliope",
position: "upper_third",
config: {
title: "Kalliope"
}
}
```
## Configuration option
| Option | Default | Description |
|--------------|----------|------------------------------------------------------------------------------------------------------------|
| max | 5 | How many messages should be keept on the screen. |
| keep_seconds | 5 | Number of seconds received messages will stay displayed. If set to "0", then message will never be removed |
| title | Kalliope | The name placed above received messages |
## API documentation
#### POST /kalliope/
Query parameters
| Parameter | Description |
|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
| notification | The notification identifier. If set to "KALLIOPE", the payload will be printed by the module. In other case the notification is sent to all other modules |
| payload | A notification payload to pass to the module. Can use plain text or JSON. |
## Curl examples
This command will send a message that will be printed by the MMM-kalliope module
```
curl -H "Content-Type: application/json" -X POST -d '{"notification":"KALLIOPE", "payload": "my message"}' http://localhost:8080/kalliope
```
Here the notification is sent to the alert module.
```
curl -H "Content-Type: application/json" -X POST -d '{"notification":"SHOW_ALERT", "payload": {"title": "mytitle", "message": "this is a test", "timer": 5000}}' http://localhost:8080/kalliope
```
## How to control my MM module from this module
All notifications that are not concerned by this module (when the notification name is not "KALLIOPE") will be send to other installed module on your Magic Mirror.
To add a notification receptor to your module, you just need to implement the `notificationReceived` method like bellow.
```js
notificationReceived: function(notification, payload){
....
if (notification === "NOTIFICAION_NAME" && payload=="bla"){
// Do some magic here with your module
}
if (notification === "NOTIFICAION_NAME" && payload=="blablabla"){
// Do some magic here with your module
}
....
},
```