Skip to content

Commit 512e3a6

Browse files
dtexrwaldron
dtex
authored and
rwaldron
committed
Examples: Update Motor Syntax
1 parent 247734c commit 512e3a6

38 files changed

+501
-679
lines changed

‎docs/motobot.md

+13-16
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,20 @@ node eg/motobot.js
1818

1919

2020
```javascript
21-
var five = require("johnny-five");
22-
var keypress = require("keypress");
23-
var board = new five.Board();
24-
25-
26-
board.on("ready", function() {
27-
var speed, commands, motors;
28-
29-
speed = 100;
30-
commands = null;
31-
motors = {
32-
a: new five.Motor([3, 12]),
33-
b: new five.Motor([11, 13])
21+
const {Board, Motor, Fn} = require("johnny-five");
22+
const keypress = require("keypress");
23+
const board = new Board();
24+
25+
board.on("ready", () => {
26+
let speed = 100;
27+
let commands = null;
28+
const motors = {
29+
a: new Motor([3, 12]),
30+
b: new Motor([11, 13])
3431
};
3532

36-
this.repl.inject({
37-
motors: motors
33+
board.repl.inject({
34+
motors
3835
});
3936

4037
function controller(ch, key) {
@@ -63,7 +60,7 @@ board.on("ready", function() {
6360
commands = [].slice.call(arguments);
6461
} else {
6562
if (ch >= 1 && ch <= 9) {
66-
speed = five.Fn.scale(ch, 1, 9, 0, 255);
63+
speed = Fn.scale(ch, 1, 9, 0, 255);
6764
controller.apply(null, commands);
6865
}
6966
}

‎docs/motor-3-pin.md

+18-29
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,10 @@ node eg/motor-3-pin.js
2929

3030

3131
```javascript
32-
var five = require("johnny-five"),
33-
board = new five.Board();
32+
const {Board, Motor} = require("johnny-five");
33+
const board = new Board();
3434

35-
board.on("ready", function() {
36-
var motor;
35+
board.on("ready", () => {
3736
/*
3837
Seeed Studio Motor Shield V1.0, V2.0
3938
Motor A
@@ -58,53 +57,43 @@ board.on("ready", function() {
5857
cdir: 2
5958
6059
*/
61-
62-
63-
motor = new five.Motor({
60+
61+
const motor = new Motor({
6462
pins: {
6563
pwm: 9,
6664
dir: 8,
6765
cdir: 11
6866
}
6967
});
7068

71-
72-
73-
7469
board.repl.inject({
75-
motor: motor
70+
motor
7671
});
7772

78-
motor.on("start", function() {
79-
console.log("start", Date.now());
73+
motor.on("start", () => {
74+
console.log(`start: ${Date.now()}`);
8075
});
8176

82-
motor.on("stop", function() {
83-
console.log("automated stop on timer", Date.now());
77+
motor.on("stop", () => {
78+
console.log(`automated stop on timer: ${Date.now()}`);
8479
});
8580

86-
motor.on("brake", function() {
87-
console.log("automated brake on timer", Date.now());
81+
motor.on("brake", () => {
82+
console.log(`automated brake on timer: ${Date.now()}`);
8883
});
8984

90-
motor.on("forward", function() {
91-
console.log("forward", Date.now());
85+
motor.on("forward", () => {
86+
console.log(`forward: ${Date.now()}`);
9287

9388
// demonstrate switching to reverse after 5 seconds
94-
board.wait(5000, function() {
95-
motor.reverse(255);
96-
});
89+
board.wait(5000, () => motor.reverse(255));
9790
});
9891

99-
motor.on("reverse", function() {
100-
console.log("reverse", Date.now());
92+
motor.on("reverse", () => {
93+
console.log(`reverse: ${Date.now()}`);
10194

10295
// demonstrate braking after 5 seconds
103-
board.wait(5000, function() {
104-
105-
// Brake for 500ms and call stop()
106-
motor.brake(500);
107-
});
96+
board.wait(5000, () => motor.brake(500));
10897
});
10998

11099
// set the motor going forward full speed

‎docs/motor-EVS_EV3.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,22 @@ node eg/motor-EVS_EV3.js
1818

1919

2020
```javascript
21-
var five = require("johnny-five");
22-
var board = new five.Board();
21+
const {Board, Motor} = require("johnny-five");
22+
const board = new Board();
2323

24-
board.on("ready", function() {
25-
var motor = new five.Motor({
24+
board.on("ready", () => {
25+
const motor = new Motor({
2626
controller: "EVS_EV3",
2727
pin: "BBM2",
2828
});
2929

30-
board.wait(2000, function() {
30+
board.wait(2000, () => {
3131
console.log("REVERSE");
3232

3333
motor.rev();
3434

3535
// Demonstrate motor stop in 2 seconds
36-
board.wait(2000, function() {
37-
motor.stop();
38-
});
36+
board.wait(2000, motor.stop);
3937
});
4038

4139
console.log("FORWARD");

‎docs/motor-EVS_NXT.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,22 @@ node eg/motor-EVS_NXT.js
1818

1919

2020
```javascript
21-
var five = require("johnny-five");
22-
var board = new five.Board();
21+
const {Board, Motor} = require("johnny-five");
22+
const board = new Board();
2323

24-
board.on("ready", function() {
25-
var motor = new five.Motor({
24+
board.on("ready", () => {
25+
const motor = new Motor({
2626
controller: "EVS_NXT",
2727
pin: "BBM2",
2828
});
2929

30-
board.wait(2000, function() {
30+
board.wait(2000, () => {
3131
console.log("REVERSE");
3232

3333
motor.rev();
3434

3535
// Demonstrate motor stop in 2 seconds
36-
board.wait(2000, function() {
37-
motor.stop();
38-
});
36+
board.wait(2000, motor.stop);
3937
});
4038

4139
console.log("FORWARD");

‎docs/motor-GROVE_I2C.md

+13-15
Original file line numberDiff line numberDiff line change
@@ -18,38 +18,36 @@ node eg/motor-GROVE_I2C.js
1818

1919

2020
```javascript
21-
var five = require("johnny-five");
22-
var board = new five.Board();
21+
const {Board, Motor} = require("johnny-five");
22+
const board = new Board();
23+
const controller = "GROVE_I2C_MOTOR_DRIVER";
2324

24-
board.on("ready", function() {
25-
var a = new five.Motor({
26-
controller: "GROVE_I2C_MOTOR_DRIVER",
25+
board.on("ready", () => {
26+
const a = new Motor({
27+
controller,
2728
pin: "A",
2829
});
2930

30-
var b = new five.Motor({
31-
controller: "GROVE_I2C_MOTOR_DRIVER",
31+
const b = new Motor({
32+
controller,
3233
pin: "B",
3334
});
3435

35-
36-
this.wait(3000, function() {
36+
this.wait(3000, () => {
3737
console.log("REVERSE");
3838

3939
a.rev(127);
4040
b.rev(127);
4141

4242
// Demonstrate motor stop in 2 seconds
43-
this.wait(3000, function() {
43+
this.wait(3000, () => {
4444
console.log("STOP");
4545
a.stop();
4646
b.stop();
4747

48-
this.wait(1000, function() {
49-
process.emit("SIGINT");
50-
});
51-
}.bind(this));
52-
}.bind(this));
48+
board.wait(1000, () => process.emit("SIGINT"));
49+
});
50+
});
5351

5452
console.log("FORWARD");
5553
a.fwd(127);

‎docs/motor-LUDUS.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,16 @@ node eg/motor-LUDUS.js
1818

1919

2020
```javascript
21-
var five = require("johnny-five");
22-
var keypress = require("keypress");
23-
var board = new five.Board();
24-
25-
board.on("ready", function() {
26-
var motors = new five.Motors([
27-
five.Motor.SHIELD_CONFIGS.SPARKFUN_LUDUS.A, // Left
28-
five.Motor.SHIELD_CONFIGS.SPARKFUN_LUDUS.B, // Right
21+
const {Board, Motor, Motors} = require("johnny-five");
22+
const keypress = require("keypress");
23+
const board = new Board();
24+
25+
board.on("ready", () => {
26+
const motors = new Motors([
27+
Motor.SHIELD_CONFIGS.SPARKFUN_LUDUS.A, // Left
28+
Motor.SHIELD_CONFIGS.SPARKFUN_LUDUS.B, // Right
2929
]);
30-
var speed = 100;
30+
let speed = 100;
3131

3232
function controller(ch, key) {
3333
if (key) {

‎docs/motor-PCA9685.md

+10-13
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,18 @@ node eg/motor-PCA9685.js
1818

1919

2020
```javascript
21-
var five = require("johnny-five"),
22-
board, motor, led;
21+
const {Board, Motor} = require("johnny-five");
2322

24-
board = new five.Board();
23+
const board = new Board();
2524

2625
/*
2726
* The PCA9685 controller has been tested on
2827
* the Adafruit Motor/Stepper/Servo Shield v2
2928
*/
3029

31-
board.on("ready", function() {
30+
board.on("ready", () => {
3231
// Create a new `motor` hardware instance.
33-
motor = new five.Motor({
32+
const motor = new Motor({
3433
pins: [8, 9, 10],
3534
controller: "PCA9685",
3635
address: 0x60
@@ -40,24 +39,22 @@ board.on("ready", function() {
4039
// the Repl instance's context;
4140
// allows direct command line access
4241
board.repl.inject({
43-
motor: motor,
42+
motor
4443
});
4544

4645
// Motor Event API
4746

4847
// "start" events fire when the motor is started.
49-
motor.on("start", function() {
50-
console.log("start", Date.now());
48+
motor.on("start", () => {
49+
console.log(`start: ${Date.now()}`);
5150

5251
// Demonstrate motor stop in 2 seconds
53-
board.wait(2000, function() {
54-
motor.stop();
55-
});
52+
board.wait(2000, motor.stop);
5653
});
5754

5855
// "stop" events fire when the motor is started.
59-
motor.on("stop", function() {
60-
console.log("stop", Date.now());
56+
motor.on("stop", () => {
57+
console.log(`stop: ${Date.now()}`);
6158
});
6259

6360
// Motor API

‎docs/motor-TB6612FNG.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,19 @@ node eg/motor-TB6612FNG.js
2929

3030

3131
```javascript
32-
var five = require("johnny-five");
33-
var Tessel = require("tessel-io");
34-
var board = new five.Board({
32+
const {Board, Switch, Sensor, Motor} = require("johnny-five");
33+
const Tessel = require("tessel-io");
34+
const board = new Board({
3535
io: new Tessel()
3636
});
3737

38-
board.on("ready", function() {
39-
var spdt = new five.Switch("a0");
40-
var throttle = new five.Sensor("b0");
38+
board.on("ready", () => {
39+
const spdt = new Switch("a0");
40+
const throttle = new Sensor("b0");
4141

4242
// See the comments below for more information about
4343
// the pins shown in this pin array argument.
44-
var motor = new five.Motor([ "a5", "a4", "a3" ]);
44+
const motor = new Motor([ "a5", "a4", "a3" ]);
4545

4646
spdt.on("open", () => {
4747
motor.stop().forward(motor.speed());

0 commit comments

Comments
 (0)