Skip to content

Commit

Permalink
Continue OVOS migration
Browse files Browse the repository at this point in the history
  • Loading branch information
goldyfruit committed Mar 19, 2024
1 parent 6c7f471 commit 9ad675f
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 12 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-pink.svg?style=flat)](https://github.com/smartgic/mycroft-magicmirror-wakeword-skill/pulls) [![Skill: MIT](https://img.shields.io/badge/ovos-skill-blue)](https://openvoiceos.org) [![Discord](https://img.shields.io/discord/809074036733902888)](https://discord.gg/Vu7Wmd9j)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-pink.svg?style=flat)](https://github.com/smartgic/skill-ovos-mm-wakeword/pulls) [![Skill: MIT](https://img.shields.io/badge/ovos-skill-blue)](https://openvoiceos.org) [![Discord](https://img.shields.io/discord/809074036733902888)](https://discord.gg/Vu7Wmd9j)

# <img src="docs/magicmirror.png" card_color="#0000" width="150" height="30" style="vertical-align:bottom"/> MagicMirror² wake word detection

Image and message display on MagicMirror² when Open Voice OS is listening.
Display an image and a message on MagicMirror² when Open Voice OS is listening.

## About

[MagicMirror²](https://magicmirror.builders/) is an open source modular smart mirror platform. With a growing list of installable modules, the MagicMirror² allows you to convert your hallway or bathroom mirror into your personal assistant.

This skill interacts with MagicMirror² to let you know if OVOS is listening. When a wake word is detected the an image and message are display on the screen and when the recording is done image and the message disappear.
This skill interacts with MagicMirror² to let you know if OVOS is listening. When a wake word is detected an image and message are display on the screen and when the recording is done image and the message disappear.

<img src='docs/screenshot.png' width='450'/>

Expand All @@ -19,14 +19,19 @@ There is no example because there is no voice interaction with Open Voice OS.
## Installation

```shell
$ pip install ovos-magicmirror-wakeword-skill
$ pip install git+https://github.com/smartgic/skill-ovos-mm-wakeword
```

## Configuration

This skill utilizes the `settings.json` file which allows you to configure this skill via `home.mycroft.ai` after a few seconds of having the skill installed you should see something like below in the https://home.mycroft.ai/#/skill location:
This skill utilizes the `~/.config/mycroft/skills/skill-ovos-mm-wakeword.smartgic/settings.json` file which allows you to configure this skill.

<img src='docs/magicmirror-wakeword-config.png' width='450'/>
```json
{
"url": "http://mm.home.lan",
"key": "en323q9WBNMK3Q04WIPNEAsdfhesammhp44"
}
```

Fill this out with your appropriate information and hit save.

Expand All @@ -51,4 +56,3 @@ Smart'Gic
#wakeword
#raspberrypi
#smarthome
#picroft
Binary file removed docs/magicmirror-wakeword-config.png
Binary file not shown.
Binary file modified docs/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions setup.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 9ad675f

Please sign in to comment.