-
Notifications
You must be signed in to change notification settings - Fork 127
Expand file tree
/
Copy pathmicropythonapi.js
More file actions
255 lines (240 loc) · 13.4 KB
/
micropythonapi.js
File metadata and controls
255 lines (240 loc) · 13.4 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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
/**
* The MicroPython API and helper functions to enable ACE autocompletion.
*/
var microPythonApi = (function () {
'use strict';
// This API can be obtained running this script on a micro:bit
// micropython/microbit-api-instropection.py
var uPyBaseApi = {
"array": ["array"],
"audio": ["AudioFrame", "play"],
"collections": [ "OrderedDict", "namedtuple"],
"gc": ["collect", "disable", "enable", "isenabled", "mem_alloc", "mem_free", "threshold"],
"machine": ["disable_irq", "enable_irq", "freq", "reset", "time_pulse_us", "unique_id"],
"math": ["acos", "asin", "atan", "atan2", "ceil", "copysign", "cos", "degrees", "e", "exp", "fabs", "floor", "fmod", "frexp", "isfinite", "isinf", "isnan", "ldexp", "log", "modf", "pi", "pow", "radians", "sin", "sqrt", "tan", "trunc"],
"microbit": {
"Image": ["ALL_CLOCKS", "ANGRY", "ARROW_E", "ARROW_N", "ARROW_NE", "ARROW_NW", "ARROW_S", "ARROW_SE", "ARROW_SW", "ARROW_W", "ASLEEP", "BUTTERFLY", "CHESSBOARD", "CLOCK1", "CLOCK10", "CLOCK11", "CLOCK12", "CLOCK2", "CLOCK3", "CLOCK4", "CLOCK5", "CLOCK6", "CLOCK7", "CLOCK8", "CLOCK9", "CONFUSED", "COW", "DIAMOND", "DIAMOND_SMALL", "DUCK", "FABULOUS", "GHOST", "GIRAFFE", "HAPPY", "HEART", "HEART_SMALL", "HOUSE", "MEH", "MUSIC_CROTCHET", "MUSIC_QUAVER", "MUSIC_QUAVERS", "NO", "PACMAN", "PITCHFORK", "RABBIT", "ROLLERSKATE", "SAD", "SILLY", "SKULL", "SMILE", "SNAKE", "SQUARE", "SQUARE_SMALL", "STICKFIGURE", "SURPRISED", "SWORD", "TARGET", "TORTOISE", "TRIANGLE", "TRIANGLE_LEFT", "TSHIRT", "UMBRELLA", "XMAS", "YES"],
"accelerometer": ["current_gesture", "get_gestures", "get_values", "get_x", "get_y", "get_z", "was_gesture"],
"button_a": ["get_presses", "is_pressed", "was_pressed"],
"button_b": ["get_presses", "is_pressed", "was_pressed"],
"compass": ["calibrate", "clear_calibration", "get_field_strength", "get_x", "get_y", "get_z", "heading", "is_calibrated"],
"display": ["clear", "get_pixel", "is_on", "off", "on", "read_light_level", "scroll", "set_pixel", "show"],
"i2c": ["init", "read", "scan", "write"],
"panic": "",
"pin0": ["is_touched", "read_analog", "read_digital", "set_analog_period", "set_analog_period_microseconds", "write_analog", "write_digital"],
"pin1": ["is_touched", "read_analog", "read_digital", "set_analog_period", "set_analog_period_microseconds", "write_analog", "write_digital"],
"pin10": ["read_analog", "read_digital", "set_analog_period", "set_analog_period_microseconds", "write_analog", "write_digital"],
"pin11": ["read_digital", "write_digital"],
"pin12": ["read_digital", "write_digital"],
"pin13": ["read_digital", "write_digital"],
"pin14": ["read_digital", "write_digital"],
"pin15": ["read_digital", "write_digital"],
"pin16": ["read_digital", "write_digital"],
"pin19": ["read_digital", "write_digital"],
"pin2": ["is_touched", "read_analog", "read_digital", "set_analog_period", "set_analog_period_microseconds", "write_analog", "write_digital"],
"pin20": ["read_digital", "write_digital"],
"pin3": ["read_analog", "read_digital", "set_analog_period", "set_analog_period_microseconds", "write_analog", "write_digital"],
"pin4": ["read_analog", "read_digital", "set_analog_period", "set_analog_period_microseconds", "write_analog", "write_digital"],
"pin5": ["read_digital", "write_digital"],
"pin6": ["read_digital", "write_digital"],
"pin7": ["read_digital", "write_digital"],
"pin8": ["read_digital", "write_digital"],
"pin9": ["read_digital", "write_digital"],
"reset": "",
"running_time": "",
"sleep": "",
"spi": ["init", "read", "write", "write_readinto"],
"temperature": "",
"uart": ["any", "init", "read", "readall", "readline", "write"]
},
"micropython": ["const", "heap_lock", "heap_unlock", "kbd_intr", "mem_info", "opt_level", "qstr_info", "stack_use"],
"music": ["BADDY", "BA_DING", "BIRTHDAY", "BLUES", "CHASE", "DADADADUM", "ENTERTAINER", "FUNERAL", "FUNK", "JUMP_DOWN", "JUMP_UP", "NYAN", "ODE", "POWER_DOWN", "POWER_UP", "PRELUDE", "PUNCHLINE", "PYTHON", "RINGTONE", "WAWAWAWAA", "WEDDING", "get_tempo", "pitch", "play", "reset", "set_tempo", "stop"],
"neopixel": {
"NeoPixel" : ["clear", "show"]
},
"os": ["listdir", "remove", "size", "uname"],
"radio": ["RATE_1MBIT", "RATE_250KBIT", "RATE_2MBIT", "config", "off", "on", "receive", "receive_bytes", "receive_bytes_into", "receive_full", "reset", "send", "send_bytes"],
"random": ["choice", "getrandbits", "randint", "random", "randrange", "seed", "uniform"],
"speech": ["pronounce", "say", "sing", "translate"],
"struct": ["calcsize", "pack", "pack_into", "unpack", "unpack_from"],
"sys": ["byteorder", "exit", "implementation", "platform", "print_exception", "version", "version_info"],
"time": ["sleep", "sleep_ms", "sleep_us", "ticks_add", "ticks_diff", "ticks_ms", "ticks_us"],
"ucollections": [ "OrderedDict", "namedtuple"],
"ustruct": ["calcsize", "pack", "pack_into", "unpack", "unpack_from"],
"utime": ["sleep", "sleep_ms", "sleep_us", "ticks_add", "ticks_diff", "ticks_ms", "ticks_us"],
};
var extraModules = {
"audio" : ["play", "AudioFrame", "stop", "is_playing"],
"microbit": {
"audio" : ["AudioFrame","is_playing", "play", "stop"],
"microphone": ["current_event", "get_events", "is_event", "set_threshold", "sound_level", "was_event"],
"pin_logo": ["CAPACITIVE", "RESISTIVE", "is_touched", "set_touch_mode"],
"pin_speaker": ["get_analog_period_microseconds", "set_analog_period", "set_analog_period_microseconds", "write_analog", "write_digital"],
"set_volume": "",
"speaker": ["off", "on"],
"Sound": ["GIGGLE", "HAPPY", "HELLO", "MYSTERIOUS", "SAD", "SLIDE", "SOARING", "SPRING", "TWINKLE", "YAWN"],
"SoundEvent": ["LOUD", "QUIET"]
},
"neopixel": {
"NeoPixel" : ["clear", "fill", "show", "write"],
},
};
/**
* Generates an expanded list of words for the ACE autocomplete to digest.
*
* @param {object} apiObj MicroPython modules in object form.
* @returns {string[]} One dimensional array with all combinations of
*/
var flattenApi = function(apiObj) {
var wordsHorizontal = [];
Object.keys(apiObj).forEach(function(module) {
wordsHorizontal.push(module);
if (Array.isArray(apiObj[module])){
apiObj[module].forEach(function(func) {
wordsHorizontal.push(module + '.' + func);
});
} else {
Object.keys(apiObj[module]).forEach(function(sub) {
wordsHorizontal.push(module + '.' + sub);
if (Array.isArray(apiObj[module][sub])) {
apiObj[module][sub].forEach(function(func) {
wordsHorizontal.push(module + '.' + sub + '.' + func);
wordsHorizontal.push(sub + '.' + func);
});
}
});
}
});
return (wordsHorizontal);
};
/**
* Generates the full API in a flat array needed for ACE autocompletion.
*
* @return {string[]} Array with all the autocompletion combinations of
* available modules.
*/
var getFullMicroPythonApi = function() {
// TODO: This does not seem to expand arrays shared by both objects
var finalObj = $.extend(true, {}, uPyBaseApi, extraModules);
return flattenApi(finalObj);
};
/**
* Generates the base API in a flat array needed for ACE autocompletion.
*
* @return {string[]} Array with all the autocompletion combinations for
* the base MicroPython API.
*/
var getBaseMicroPythonApi = function() {
return flattenApi(uPyBaseApi);
};
/**
* Based on the board ID it generates the appropriate MicroPython API in a
* flat array needed for ACE autocompletion.
*
* @return {string[]} Array with all the autocompletion combinations for
* the MicroPython version relevant to the board ID.
*/
var getCompatibleMicroPythonApi = function(boardId) {
if (boardId == '9900' || boardId == '9901') {
return getBaseMicroPythonApi();
} else {
return getFullMicroPythonApi();
}
}
/**
* Detect Python imports in the provided Python code string.
*
* Current it does not support multiline imports:
* from microbit import (display,
* Image)
* Or top level nested imports with an alias
* import microbit.display as d
*
* Having the value "module-import" indicates that key has been imported,
* as python modules cannot have the "-" character it shouldn't clash.
* If it's not present that package has not been imported directly and
* there should be nested packages/modules/variables imported instead.
*
* @param {string} PyCode Python code string to analyse.
* @return {object} Object with the modules as keys and imports as values.
*/
var detectImports = function(pyCode) {
var match;
var imports = {};
var importRegex = /^(?:from[ \t]+(\S+)[ \t]+)?import[ \t]+(.*)[ ]*$/mg;
while ((match = importRegex.exec(pyCode)) !== null) {
// Avoid infinite loops with zero-width matches
if (match.index === importRegex.lastIndex) importRegex.lastIndex++;
// match[0] is the full line
if (!match[1] && match[2]) {
// import match[2]
// Separate multiple imports in the same line
match[2].split(',').forEach(function(singleImport) {
// Check nested packages with "." e.g. import microbit.display
var packages = singleImport.split('.');
packages.reduce(function (parentPackageObj, currentPackageName) {
if (!currentPackageName) return parentPackageObj;
// Ignore import renames with the "as" expression
currentPackageName = currentPackageName.split('as')[0].trim();
parentPackageObj[currentPackageName] = parentPackageObj[currentPackageName] || {};
// With the "from" keyword each nested package is globally available
parentPackageObj[currentPackageName]['module-import'] = null;
return parentPackageObj[currentPackageName];
}, imports);
});
} else if (match[1] && match[2]) {
// from match[1] import match[2]
// Check nested packages with "." e.g. from microbit.Image import HAPPY
var packages = match[1].split('.');
var finalNestedPackage = packages.reduce(function (parentPackageObj, currentPackageName) {
if (!currentPackageName) return parentPackageObj;
currentPackageName = currentPackageName.trim();
parentPackageObj[currentPackageName] = parentPackageObj[currentPackageName] || {};
return parentPackageObj[currentPackageName];
}, imports);
// Now, after "import" we can have multiple imports with comma separators
match[2].split(',').forEach(function(singleImport) {
// Ignore import renames with the "as" expression
var importName = singleImport.split('as')[0].trim();
finalNestedPackage[importName] = finalNestedPackage[importName] || {};
finalNestedPackage[importName]['module-import'] = null;
});
}
}
return imports;
};
var isApiUsedCompatible = function(boardId, pyCode) {
if (['9903', '9904', '9905', '9906'].indexOf(boardId) >= 0) {
return true;
} else if (['9900', '9901'].indexOf(boardId) >= 0) {
var additionalModules = Object.keys(extraModules)
var includesExtra = false;
var imports = detectImports(pyCode);
Object.keys(imports).forEach(function(topLevelModule) {
if (additionalModules.indexOf(topLevelModule) > -1) {
includesExtra = true;
}
});
return !includesExtra;
} else {
throw new Error('Could not recognise the Board ID ' + boardId);
}
};
var publicApi = {
'getFullApi': getFullMicroPythonApi,
'getBaseApi': getBaseMicroPythonApi,
'getCompatibleMicroPythonApi': getCompatibleMicroPythonApi,
'isApiUsedCompatible': isApiUsedCompatible,
};
if (typeof jasmine !== 'undefined' || typeof jest !== 'undefined') {
// Add these private functions when running unit tests
publicApi['flattenApi'] = flattenApi;
publicApi['detectImports'] = detectImports;
}
return publicApi;
})();
if (typeof module !== 'undefined' && module.exports) {
global.microPythonApi = microPythonApi;
} else {
window.microPythonApi = microPythonApi;
}