Skip to content

Commit

Permalink
update readmes for import script
Browse files Browse the repository at this point in the history
  • Loading branch information
zankavrogin committed Dec 12, 2014
1 parent f9237bf commit 4091681
Show file tree
Hide file tree
Showing 15 changed files with 149 additions and 78 deletions.
14 changes: 7 additions & 7 deletions platforms/ardrone/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
# Ardrone

This package provides the Gobot adaptor and driver for the [Parrot Ardrone](http://ardrone2.parrot.com).
The ARDrone from Parrot is an inexpensive quadcopter that is controlled using WiFi. It includes a built-in front-facing HD video camera, as well as a second lower resolution bottom facing video camera.

For more information about Gobot, check out the github repo at
https://github.com/hybridgroup/gobot
For more info about the ARDrone platform click [here](http://ardrone2.parrot.com/).

## Getting Started

## Installing
## How to Install
```
go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/gobot/platforms/ardrone
```
## Using
## How to Use
```go
package main

Expand Down Expand Up @@ -47,3 +44,6 @@ func main() {
gbot.Start()
}
```
## How to Connect

The ARDrone is a WiFi device, so there is no additional work to establish a connection to a single drone. However, in order to connect to multiple drones, you need to perform some configuration steps on each drone via SSH.
12 changes: 7 additions & 5 deletions platforms/beaglebone/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Beaglebone

This package provides the Gobot adaptor for the [Beaglebone Black](http://beagleboard.org/Products/BeagleBone+Black/)
The BeagleBone is an ARM based single board computer, with many different GPIO interfaces built in.

## Getting Started
For more info about the BeagleBone platform click [here](http://beagleboard.org/Products/BeagleBone+Black).

## Installing
## How to Install
```
go get -d -u github.com/hybridgroup/gobot/... && go install github.com/hybridgroup/gobot/platforms/beaglebone
```
Expand All @@ -18,17 +18,19 @@ $ GOOS=linux GOARCH=arm ./make.bash --no-clean
```

Then compile your Gobot program with

```bash
$ GOARM=7 GOARCH=arm GOOS=linux go build examples/beaglebone_blink.go
```

If you are running the official Angstrom or Debian linux through the usb->ethernet connection, you can simply upload your program and execute it with
``` bash

```bash
$ scp beaglebone_blink [email protected]:/home/root/
$ ssh -t [email protected] "./beaglebone_blink"
```

## Example
## How to Use

```go
package main
Expand Down
10 changes: 7 additions & 3 deletions platforms/digispark/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Digispark

The Digispark is an Attiny85 based microcontroller development board similar to the Arduino line, only cheaper, smaller, and a bit less powerful. With a whole host of shields to extend its functionality and the ability to use the familiar Arduino IDE the Digispark is a great way to jump into electronics, or perfect for when an Arduino is too big or too much.

This package provides the Gobot adaptor for the [Digispark](http://digistump.com/products/1) ATTiny-based USB development board with the [Little Wire](http://littlewire.cc/) protocol firmware installed.

## Getting Started
## How to Install

This package requires `libusb`.

Expand All @@ -23,11 +25,13 @@ $ sudo apt-get install libusb-dev
```

Now you can install the package with

```
go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/gobot/platforms/digispark
```

## Examples
## How to Use

```go
package main

Expand Down Expand Up @@ -62,7 +66,7 @@ func main() {
gbot.Start()
}
```
## Connecting to Digispark
## How to Connect

If your Digispark already has the Little Wire protocol firmware installed, you can connect right away with Gobot.

Expand Down
8 changes: 6 additions & 2 deletions platforms/firmata/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# Firmata

Arduino is an open-source electronics prototyping platform based on flexible, easy-to-use hardware and software. It's intended for artists, designers, hobbyists and anyone interested in creating interactive objects or environments.

This package provides the adaptor for microcontrollers such as Arduino that support the [Firmata](http://firmata.org/wiki/Main_Page) protocol

## Getting Started
For more info about the arduino platform click [here](http://arduino.cc/).

## How to Install

```
go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/gobot/platforms/firmata
```

## Example
## How to Use

```go
package main
Expand Down
21 changes: 13 additions & 8 deletions platforms/intel-iot/edison/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# Edison
# Edison

This package contains the Gobot adaptor for the [Intel Edison](http://www.intel.com/content/www/us/en/do-it-yourself/edison.html) IoT platform.
The Intel Edison is a wifi and Bluetooth® enabled devolopment platform for the Internet of Things. It packs a robust set of features into its small size and supports a broad spectrum of I/O and software support.

This package currently supports the following Intel IoT hardware:
- Intel Edison with the Arduino breakout board
For more info about the Edison platform click [here](http://www.intel.com/content/www/us/en/do-it-yourself/edison.html).

## Getting Started
## How to Install

First you must install the appropriate Go packages

Expand All @@ -29,21 +28,24 @@ $ GOOS=linux GOARCH=386 ./make.bash --no-clean
```

Then compile your Gobot program with

```bash
$ GOARCH=386 GOOS=linux go build examples/edison_blink.go
```

Then you can simply upload your program over the network from your host computer to the Edison
``` bash
Then you can simply upload your program over the network from your host computer to the Edison

```bash
$ scp edison_blink [email protected]:/home/root/
```

and execute it on your Edison with

```bash
$ ./edison_blink
```

## Example
## How to Use

```go
package main
Expand Down Expand Up @@ -79,3 +81,6 @@ func main() {
gbot.Start()
}
```
## How to Connect

The [Intel Edison Getting Started Guide](https://communities.intel.com/docs/DOC-23147) details connection instructions for Windows, Mac and Linux.
17 changes: 13 additions & 4 deletions platforms/joystick/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Joystick

This package provides the Gobot adaptor and drivers for the PS3 controller, Xbox 360 controller, or any other joysticks and game controllers that are compatible with [Simple DirectMedia Layer](http://www.libsdl.org/).
You can use Gobot with a Dualshock3 game controller, an XBox360 game controller, or any other USB joystick or game controller that is compatible with [Simple DirectMedia Layer](http://www.libsdl.org/).

## Getting Started
## How to Install

This package requires `sdl2` to be installed on your system

Expand All @@ -21,13 +21,15 @@ $ sudo apt-get install libsdl2-2.0-0
```

Now you can install the package with

```
go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/gobot/platforms/joystick
```

## Usage
## How to Use

Controller configurations are stored in JSON format. Here's an example configuration file for the Dualshock 3 controller

```json
{
"name": "Sony PLAYSTATION(R)3 Controller",
Expand Down Expand Up @@ -123,7 +125,14 @@ Controller configurations are stored in JSON format. Here's an example configura
}
```

## How to Connect

Plug your USB joystick or game controller into your USB port. If your device is supported by SDL, you are now ready.

## Examples

This small program receives joystick and button press events from an PlayStation 3 game controller.

```go
package main

Expand Down Expand Up @@ -180,4 +189,4 @@ func main() {

gbot.Start()
}
```
```
31 changes: 28 additions & 3 deletions platforms/leap/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
# Leap

This package provides the Gobot adaptor and driver for the [Leap Motion](https://www.leapmotion.com/)
The Leap Motion is a user-interface device that tracks the user's hand motions, and translates them into events that can control robots and physical computing hardware.

## Getting Started
For more info about the Leap Motion platform click [Leap Motion](https://www.leapmotion.com/)

## How to Install

First install the [Leap Motion Software](https://www.leapmotion.com/setup)

Now you can install the package with

```
go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/gobot/platforms/leap
```

## Example
## How to Use

```go
package main
Expand Down Expand Up @@ -46,3 +49,25 @@ func main() {
gbot.Start()
}
```

## How To Connect

###OSX

This driver works out of the box with the vanilla installation of the Leap Motion Software that you get in their [Setup Guide](https://www.leapmotion.com/setup).

The main steps are:

* Run Leap Motion.app to open a websocket connection in port 6437.
* Connect your Computer and Leap Motion Controller.
* Connect to the device via Gobot.

### Ubuntu

The Linux download of the Leap Motion software can be obtained from [Leap Motion Dev Center](https://developer.leapmotion.com/downloads) (requires free signup)

The main steps are:

* Run the leapd daemon, to open a websocket connection in port 6437.
* Connect your computer and the Leap Motion controller
* Connect to the device via Gobot
16 changes: 8 additions & 8 deletions platforms/mavlink/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# mavlink
# Mavlink

Gobot (http://gobot.io/) is a framework for robotics and physical computing using Go
For information on the MAVlink communication protocol click [here](http://qgroundcontrol.org/mavlink/start).

This repository contains the Gobot adaptor and driver for the [MAVlink Communication Protocol](http://qgroundcontrol.org/mavlink/start).
## How to Install

For more information about Gobot, check out the github repo at
https://github.com/hybridgroup/gobot
```
go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/gobot/platforms/mavlink
```

## Installing
`go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/gobot/platforms/mavlink`
## How to Use

## Using
```go
package main

Expand Down
19 changes: 8 additions & 11 deletions platforms/mqtt/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
# Gobot for MQTT
# MQTT

Gobot (http://gobot.io/) is a library for robotics and physical computing using Go
MQTT is an Internet of Things connectivity protocol featuring a lightweight publish/subscribe messaging transport. It is useful for it's small code footprint and minimal network bandwidth usage.

This repository contains the Gobot adaptor for the MQTT machine to machine message broker (http://mqtt.org/).
For more info about the MQTT machine to machine message broker click [here](http://mqtt.org/).

## Installing
## How to Install

Install running:

* Install running:
```
go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/gobot/platforms/mqtt
```

## Using
## How to Use

* Before running the example, make sure you have an MQTT message broker running somewhere you can connect to
Before running the example, make sure you have an MQTT message broker running somewhere you can connect to

```go
package main
Expand Down Expand Up @@ -62,11 +63,7 @@ func main() {
* Publish messages
* Respond to incoming message events

## Documentation

We're busy adding documentation to our web site at http://gobot.io/ please check there as we continue to work on Gobot

Thank you!

## Contributing

Expand Down
13 changes: 9 additions & 4 deletions platforms/neurosky/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# Neurosky

NeuroSky delivers fully integrated, single chip EEG biosensors. NeuroSky enables its partners and developers to bring their brainwave application ideas to market with the shortest amount of time, and lowest end consumer price.

This package contains the Gobot adaptor and driver for the [Neurosky Mindwave Mobile EEG](http://store.neurosky.com/products/mindwave-mobile).

## Installing
## How to Install
Installing Gobot with Neurosky support is pretty easy.

```
go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/gobot/platforms/neurosky
```
Expand Down Expand Up @@ -38,7 +42,9 @@ gort bluetooth connect <address>

You should be able to pair your Mindwave using your normal system tray applet for Bluetooth, and then connect to the COM port that is bound to the device, such as `COM3`.

## Examples
## How to Use

This small program lets you connect the Neurosky an load data.

```go
package main
Expand Down Expand Up @@ -98,5 +104,4 @@ func main() {
gbot.AddRobot(robot)
gbot.Start()
}

```
```
11 changes: 8 additions & 3 deletions platforms/opencv/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# OpenCV

This repository contains the Gobot drivers for opencv.
OpenCV (Open Source Computer Vision Library) is an open source computer vision and machine learning software library. OpenCV was built to provide a common infrastructure for computer vision applications and to accelerate the use of machine perception in the commercial products. Being a BSD-licensed product, OpenCV makes it easy for businesses to utilize and modify the code.

## Getting Started
For more info about OpenCV click [here](http://opencv.org/)

## How to Install

This package requires `opencv` to be installed on your system

Expand All @@ -28,7 +30,10 @@ Now you can install the package with
go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/gobot/platforms/opencv
```

## Using
## How to Use

Example using the camera.

```go
package main

Expand Down
Loading

0 comments on commit 4091681

Please sign in to comment.