UNPKG

dream-cheeky-driver

Version:

Driver for Dream Cheeky Missile Launcher

github.com/GoGoCodeJam/dream-cheeky-api

GoGoCodeJam/dream-cheeky-api

151 lines (92 loc) • 2.8 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
dream-cheeky-api ================ Nodejs API for controller dream cheeky missile launcher. This is a reinforcement of [pathikrit's *node-thunder-driver* library](https://github.com/pathikrit/node-thunder-driver), with some unexpected behaviours removed and extra features. ____________________ Installation ============== 1. `npm install dream-cheeky-driver` 2. In your js file, add `var DCDriver = require('dream-cheeky-driver');` ____________________ API ============== ###DCDriver ####DCDriver.DEVICE_CONSTANTS **Description:** A JS object containing constants for Dream Cheeky Thunder Launcher. ####DCDriver.turnOnDebugMode() **Description:** Turn on debug mode (level 4) of USB. ####DCDriver.turnOffDebugMode() **Description:** Turn off USB debug mode (ie. debug level 0). ####DCDriver.moveUp(`durationMS`[, `callback`]) **Description:** Move up for a period of time. **Parameters:** #####`durationMS` Type: Number Duration of moving time in ms. #####`callback` Type: Function() A function to execute when the movement is done. ####DCDriver.moveDown(`durationMS`[, `callback`]) **Description:** Move down for a period of time. **Parameters:** #####`durationMS` Type: Number Duration of moving time in ms. #####`callback` Type: Function() A function to execute when the movement is done. ####DCDriver.moveLeft(`durationMS`[, `callback`]) **Description:** Move left for a period of time. **Parameters:** #####`durationMS` Type: Number Duration of moving time in ms. #####`callback` Type: Function() A function to execute when the movement is done. ####DCDriver.moveRight(`durationMS`[, `callback`]) **Description:** Move right for a period of time. **Parameters:** #####`durationMS` Type: Number Duration of moving time in ms. #####`callback` Type: Function() A function to execute when the movement is done. ####DCDriver.stop([`callback`]) Stop movement immediately. **Parameters:** #####`callback` Type: Function() A function to execute when the movement is stopped. ####DCDriver.fire(`numberOfShot`[, `callback`]) Shoot for `numberOfShot` times consecutively. **Parameters:** #####`numberOfShot` Type: Number Number of shots #####`callback` Type: Function() A function to execute when all the shooting is done (and when the target is utterly destroyed!). ####DCDriver.park([`callback`]) Go back to a fixed default location (leftmost and bottommost position). **Parameters:** #####`callback` Type: Function() A function to execute when all the movement is done. ####DCDriver.execute(`commands`[, `callback`]) **NOT STABLE** yet, will be improved. Convenient method to specify a chain of commands **Parameters:** #####`commands` Type: String #####`callback` Type: Function() A function to execute when the chain of commands is done.