Skip to content

Fix docs on sphero.roll #1

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.

Sign up for GitHub

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

Open
c-goosen wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Fix docs on sphero.roll #1

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
98ac0d1
Update roll docs
Sep 4, 2018
ba15269
Fix bullet points
Sep 4, 2018
745224a
Fix markdown on sphero.roll
Sep 4, 2018
4a30f7e
Fixed more formating
Sep 4, 2018
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
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,10 @@ We've also created a Sphero CLI for the Make Day so if you want to have a look a

* `sphero.connect`: Connects to Sphero. All your code goes inside this function.

* `sphero.roll`: Takes two arguments - distance (unitless) and direction (in degrees). The direction you specify is clockwise relative to the x-axis - see the image below:
* `sphero.roll`: Takes two arguments - speed (unitless) and direction (in degrees). The direction you specify is clockwise relative to the x-axis - see the image below:
<img src="assets/clockwise_rotation.png" width="150" height="150" />
* To calculate distance with the sphero you will have to use the formala distance = speed x time or d = st
* [Refer to this link for distance time speed explanations](http://www.softschools.com/formulas/physics/distance_speed_time_formula/75/)

* `sphero.setColor`: Takes a string with the color as argument. In lower-case, e.g. "blue", "red", "green", etc.

Expand Down Expand Up @@ -53,4 +55,4 @@ We've also created a Sphero CLI for the Make Day so if you want to have a look a
In `sphero.js` there are the following files of note:
* In `/lib/commands`: `core.js` and `sphero.js`
* `/lib/devices`: `core.js`, `custom.js` and `sphero.js`
* -->
* -->