diff --git a/data/platforms.json b/data/platforms.json index ef38d1fb..2d044b58 100644 --- a/data/platforms.json +++ b/data/platforms.json @@ -34,6 +34,11 @@ "drivers": ["BLE"] }, + "CHIP": { + "slug": "chip", + "drivers": ["GPIO", "I2C"] + }, + "Crazyflie": { "slug": "crazyflie", "drivers": ["Crazyflie"] diff --git a/data/sidebar.json b/data/sidebar.json index 5b4fb941..f57cfc9d 100644 --- a/data/sidebar.json +++ b/data/sidebar.json @@ -18,6 +18,7 @@ "Beaglebone": "/documentation/platforms/beaglebone", "Bebop": "/documentation/platforms/bebop", "BLE": "/documentation/platforms/ble", + "C.H.I.P.": "/documentation/platforms/chip", "Crazyflie": "/documentation/platforms/crazyflie", "Digispark": "/documentation/platforms/digispark", "Imp": "/documentation/platforms/imp", diff --git a/source/documentation/platforms/chip.html.haml b/source/documentation/platforms/chip.html.haml new file mode 100644 index 00000000..4041cbac --- /dev/null +++ b/source/documentation/platforms/chip.html.haml @@ -0,0 +1,36 @@ +--- +title: C.H.I.P. with Cylon.js +author: The Hybrid Group +page_title: Platforms - C.H.I.P. +page_subtitle: Cylon has an extensible system for connecting to hardware devices. +page_title_docs: C.H.I.P. +page_subtitle_docs: "Repository| Issues" +layout: documentation +page_title_show: true +subnav_platform: true +active_menu_platforms: true +subnavjs: true +--- +%section.intro + = image_tag "/images/devices/chip.jpg", class: "display" + .info-intro + %h4.subtitle= current_page.data.page_subtitle_docs + :markdown + The CHIP is a small, inexpensive ARM based single board computer, + with many different IO interfaces available on the pin headers. + + For more info about the CHIP platform click [here](http://www.nextthing.co/pages/chip). + + .clear + += partial "documentation/platforms/partials/chip" + +%section.drivers#Drivers + :markdown + ## Drivers + + All Cylon digital GPIO and i2c drivers listed below should work with the C.H.I.P.: + + .hardware + .devices + = partial "/partials/devices_for_platform", locals: { platform: "CHIP" } diff --git a/source/documentation/platforms/partials/_chip.html.haml b/source/documentation/platforms/partials/_chip.html.haml new file mode 100644 index 00000000..ee97ba85 --- /dev/null +++ b/source/documentation/platforms/partials/_chip.html.haml @@ -0,0 +1,55 @@ +%section.how-to + :markdown + ## How to Install + + Install the module with: + + $ npm install cylon cylon-chip + + + ## How to Use + + :::javascript + "use strict"; + + var Cylon = require("cylon"); + + Cylon.robot({ + connections: { + beaglebone: { adaptor: "chip" } + }, + + devices: { + led: { driver: "led", pin: "" }, + button: { driver: "button", pin: "" } + }, + + work: function(my) { + my.button.on('push', function() {my.led.toggle()}); + } + }).start(); + + ## How to Connect + + You will likely want to connect your development machine to your C.H.I.P. while working on your code. + You can do this easily, just by connecting to the C.H.I.P. over USB. Then, you can connect to the + C.H.I.P. using Network-Over-USB, and upload driver or configuration changes. + + ### OSX + + Info goes here + + ### Linux + + Info goes here + + ### Windows + + Info goes here + + ### Credentials + + By default, the C.H.I.P's login credentials are: + + - user: root + - pass: chip diff --git a/source/images/devices/chip.jpg b/source/images/devices/chip.jpg new file mode 100644 index 00000000..e1e315be Binary files /dev/null and b/source/images/devices/chip.jpg differ