Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Muse documentation #119

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions data/platforms.json
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,11 @@
"drivers": ["MQTT"]
},

"Muse": {
"slug": "muse",
"drivers": []
},

"Nest": {
"slug": "nest",
"drivers": ["Nest - Home", "Nest - Thermostat", "Nest - Protect"]
Expand Down
1 change: 1 addition & 0 deletions data/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"M2X": "/documentation/platforms/m2x",
"MiP": "/documentation/platforms/mip",
"MQTT": "/documentation/platforms/mqtt",
"Muse": "/documentation/platforms/muse",
"Nest": "/documentation/platforms/nest",
"Neurosky Mindwave": "/documentation/platforms/neurosky",
"Octoblu": "/documentation/platforms/octoblu",
Expand Down
31 changes: 31 additions & 0 deletions source/documentation/platforms/muse.html.haml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
page_title_show: true
title: Muse with Cylon
author: The Hybrid Group
page_title: Platforms - Muse
page_subtitle: Cylon has an extensible system for connecting to hardware devices.
page_title_docs: Muse
page_subtitle_docs: "<a href='https://github.com/hybridgroup/cylon-muse' class='repository'>Repository</a>| <a class='issues' href='https://github.com/hybridgroup/cylon-muse/issues'>Issues</a>"
layout: documentation
subnav_platform: true
active_menu_platforms: true
subnavjs: true
---
%section.intro
= image_tag "/images/devices/muse.jpg", class: "display"
.info-intro
%h4.subtitle= current_page.data.page_subtitle_docs
:markdown
Muse is the first tool in the world that gives you accurate, real-time feedback on what’s happening in your brain when you meditate.

For more info about the Muse device click [here](http://www.choosemuse.com/).
.clear

= partial "documentation/platforms/partials/muse"

%section.drivers#Drivers
%h2 Drivers

.hardware
.devices
= partial "/partials/devices_for_platform", locals: { platform: "Muse"}
20 changes: 2 additions & 18 deletions source/documentation/platforms/partials/_muse.html.haml
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@

Install the module with: `npm install cylon-muse`

## Examples

## Connecting
## How to Use

:::javascript
var Cylon = require('cylon');
Expand All @@ -28,18 +26,4 @@
}
}).start();

Explain how to connect from the computer to the device here...

## Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style.
Add unit tests for any new or changed functionality. Lint and test your code
using `make test` and `make lint`.

## Release History

None yet...

## License

Copyright (c) 2014 Your Name Here. See `LICENSE` for more details
## How to Connect
Binary file added source/images/devices/muse.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.