https://github.com/stuartjmackintosh/mycroftapi

A Python package to interact with Mycroft's messagebus to send notifications and more
https://github.com/stuartjmackintosh/mycroftapi

Last synced: about 1 year ago
JSON representation

A Python package to interact with Mycroft's messagebus to send notifications and more

• Host: GitHub
• URL: https://github.com/stuartjmackintosh/mycroftapi
• Owner: StuartJMackintosh
• Created: 2018-06-10T15:44:21.000Z (about 8 years ago)
• Default Branch: dev
• Last Pushed: 2020-07-29T18:16:58.000Z (almost 6 years ago)
• Last Synced: 2025-04-30T04:46:48.171Z (about 1 year ago)
• Language: Python
• Size: 47.9 KB
• Stars: 0
• Watchers: 1
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.rst

Awesome Lists containing this project

README

          
# Mycroft API [![Build Status](https://travis-ci.org/Geeked-Out-Solutions/mycroftapi.svg?branch=dev)](https://travis-ci.org/Geeked-Out-Solutions/mycroftapi) [![Stories in Ready](https://badge.waffle.io/Geeked-Out-Solutions/mycroftapi.svg?label=ready&title=Ready)](http://waffle.io/Geeked-Out-Solutions/mycroftapi) [![Coverage Status](https://coveralls.io/repos/github/Geeked-Out-Solutions/mycroftapi/badge.svg?branch=dev)](https://coveralls.io/github/Geeked-Out-Solutions/mycroftapi?branch=dev) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

To be used to interact with a mycroft instance https://mycroft.ai.  Right now only feature supported is speaking text but more coming soon.

## Installing

`pip install mycroftapi`

## How to Use

Below is a python code sample to show how to use the API, currently has a lot of things supported from changing eye color and more.

This example shows how to have Hello Brian scrolled across the display until I send it a reset.

```

from mycroftapi import MycroftAPI

mycroft_ip = '10.0.0.7'

text = 'hello Brian'

mycroft = MycroftAPI(mycroft_ip)

mycroft.speak_text(text)

```

# Features

- scroll text

- change eye colors

- blink eyes

- eyes off/on

- mute speaker

- change eye brightness

- control mouth visuals like smiling, etc

- speak text to mycroft to have it speak it