Skip to content

Commit 763c53d

Browse files
thomasjballthomasjball
committed
start bringing back doc gen
1 parent 9a14dfc commit 763c53d

1 file changed

Lines changed: 140 additions & 135 deletions

File tree

‎docs.ts‎

Lines changed: 140 additions & 135 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ namespace docs {
4444
renderIcons(images)
4545
const samples = renderSamples(images)
4646
appendImage(images, "image", "microcode", microcode.wordLogo)
47-
appendImage(images, "image", "microbit", microcode.microbitLogo)
47+
// appendImage(images, "image", "microbit", microcode.microbitLogo)
4848
appendImage(
4949
images,
5050
"image",
@@ -120,7 +120,8 @@ namespace docs {
120120
function _renderProgram(): { [name: string]: Bitmap } {
121121
const r: { [name: string]: Bitmap } = {}
122122
const loader = new microcode.Editor(app)
123-
loader.rendering = true
123+
// TODO: revisit rendering flag
124+
// loader.rendering = true
124125
app.pushScene(loader)
125126
loader.cursor.visible = false
126127

@@ -147,7 +148,7 @@ namespace docs {
147148
loader.pageEditor.layout()
148149
Screen.setImageSize(pw, loader.pageHeight())
149150
const editor = new microcode.Editor(app)
150-
editor.rendering = true
151+
// TODO: editor.rendering = true
151152
app.pushScene(editor)
152153
editor.cursor.visible = false
153154
pause(500)
@@ -202,12 +203,16 @@ namespace docs {
202203
function appendImage(
203204
images: RenderedImage[],
204205
type: "icon" | "sample" | "icon_sample" | "image" | "program",
205-
name: string,
206+
name: string | number,
206207
img: Bitmap
207208
) {
209+
const newName =
210+
typeof name == "string"
211+
? name
212+
: microcode.resolveTooltip("T" + name)
208213
const msg: RenderedImage = {
209214
type,
210-
name: name.replaceAll(" ", "_").replaceAll(",", ""),
215+
name: newName.replaceAll(" ", "_").replaceAll(",", ""),
211216
pixels: imageToBuffer(img).toHex(),
212217
}
213218
images.push(msg)
@@ -226,50 +231,50 @@ namespace docs {
226231
"hot_potato",
227232
"clap_lights",
228233
"railroad_crossing",
229-
microcode.TID_ACTUATOR_CAR,
230-
microcode.TID_MODIFIER_CAR_FORWARD,
231-
microcode.TID_MODIFIER_CAR_FORWARD_FAST,
232-
microcode.TID_MODIFIER_CAR_REVERSE,
233-
microcode.TID_MODIFIER_CAR_TURN_LEFT,
234-
microcode.TID_MODIFIER_CAR_TURN_RIGHT,
235-
microcode.TID_MODIFIER_CAR_STOP,
236-
microcode.TID_MODIFIER_CAR_SPIN_LEFT,
237-
microcode.TID_MODIFIER_CAR_SPIN_RIGHT,
238-
microcode.TID_MODIFIER_CAR_LED_COLOR_1,
239-
microcode.TID_MODIFIER_CAR_LED_COLOR_2,
240-
microcode.TID_MODIFIER_CAR_LED_COLOR_3,
241-
microcode.TID_MODIFIER_CAR_LED_COLOR_4,
242-
microcode.TID_MODIFIER_CAR_ARM_OPEN,
243-
microcode.TID_MODIFIER_CAR_ARM_CLOSE,
244-
microcode.TID_MODIFIER_ON,
245-
microcode.TID_MODIFIER_OFF,
246-
microcode.TID_SENSOR_CAR_WALL,
247-
microcode.TID_SENSOR_LINE,
248-
microcode.TID_FILTER_LINE_LEFT,
249-
microcode.TID_FILTER_LINE_RIGHT,
250-
microcode.TID_FILTER_LINE_BOTH,
251-
microcode.TID_FILTER_LINE_NEITHER,
252-
microcode.TID_FILTER_LINE_NEITHER_LEFT,
253-
microcode.TID_FILTER_LINE_NEITHER_RIGHT,
254-
microcode.TID_FILTER_KITA_KEY_1,
255-
microcode.TID_FILTER_KITA_KEY_2,
256-
microcode.TID_SENSOR_MAGNET,
257-
microcode.TID_SENSOR_SLIDER,
258-
microcode.TID_SENSOR_ROTARY,
259-
microcode.TID_FILTER_ROTARY_LEFT,
260-
microcode.TID_FILTER_ROTARY_RIGHT,
261-
microcode.TID_ACTUATOR_RGB_LED,
262-
microcode.TID_MODIFIER_RGB_LED_COLOR_1,
263-
microcode.TID_MODIFIER_RGB_LED_COLOR_2,
264-
microcode.TID_MODIFIER_RGB_LED_COLOR_3,
265-
microcode.TID_MODIFIER_RGB_LED_COLOR_4,
266-
microcode.TID_MODIFIER_RGB_LED_COLOR_5,
267-
microcode.TID_MODIFIER_RGB_LED_COLOR_6,
268-
microcode.TID_MODIFIER_RGB_LED_COLOR_RAINBOW,
269-
microcode.TID_MODIFIER_RGB_LED_COLOR_SPARKLE,
270-
microcode.TID_ACTUATOR_SERVO_SET_ANGLE,
271-
microcode.TID_ACTUATOR_RELAY,
272-
microcode.TID_ACTUATOR_SERVO_POWER,
234+
microcode.Tid.TID_ACTUATOR_CAR,
235+
microcode.Tid.TID_MODIFIER_CAR_FORWARD,
236+
microcode.Tid.TID_MODIFIER_CAR_FORWARD_FAST,
237+
microcode.Tid.TID_MODIFIER_CAR_REVERSE,
238+
microcode.Tid.TID_MODIFIER_CAR_TURN_LEFT,
239+
microcode.Tid.TID_MODIFIER_CAR_TURN_RIGHT,
240+
microcode.Tid.TID_MODIFIER_CAR_STOP,
241+
microcode.Tid.TID_MODIFIER_CAR_SPIN_LEFT,
242+
microcode.Tid.TID_MODIFIER_CAR_SPIN_RIGHT,
243+
microcode.Tid.TID_MODIFIER_CAR_LED_COLOR_1,
244+
microcode.Tid.TID_MODIFIER_CAR_LED_COLOR_2,
245+
microcode.Tid.TID_MODIFIER_CAR_LED_COLOR_3,
246+
microcode.Tid.TID_MODIFIER_CAR_LED_COLOR_4,
247+
microcode.Tid.TID_MODIFIER_CAR_ARM_OPEN,
248+
microcode.Tid.TID_MODIFIER_CAR_ARM_CLOSE,
249+
microcode.Tid.TID_MODIFIER_ON,
250+
microcode.Tid.TID_MODIFIER_OFF,
251+
microcode.Tid.TID_SENSOR_CAR_WALL,
252+
microcode.Tid.TID_SENSOR_LINE,
253+
microcode.Tid.TID_FILTER_LINE_LEFT,
254+
microcode.Tid.TID_FILTER_LINE_RIGHT,
255+
microcode.Tid.TID_FILTER_LINE_BOTH,
256+
microcode.Tid.TID_FILTER_LINE_NEITHER,
257+
microcode.Tid.TID_FILTER_LINE_NEITHER_LEFT,
258+
microcode.Tid.TID_FILTER_LINE_NEITHER_RIGHT,
259+
microcode.Tid.TID_FILTER_KITA_KEY_1,
260+
microcode.Tid.TID_FILTER_KITA_KEY_2,
261+
microcode.Tid.TID_SENSOR_MAGNET,
262+
microcode.Tid.TID_SENSOR_SLIDER,
263+
microcode.Tid.TID_SENSOR_ROTARY,
264+
microcode.Tid.TID_FILTER_ROTARY_LEFT,
265+
microcode.Tid.TID_FILTER_ROTARY_RIGHT,
266+
microcode.Tid.TID_ACTUATOR_RGB_LED,
267+
microcode.Tid.TID_MODIFIER_RGB_LED_COLOR_1,
268+
microcode.Tid.TID_MODIFIER_RGB_LED_COLOR_2,
269+
microcode.Tid.TID_MODIFIER_RGB_LED_COLOR_3,
270+
microcode.Tid.TID_MODIFIER_RGB_LED_COLOR_4,
271+
microcode.Tid.TID_MODIFIER_RGB_LED_COLOR_5,
272+
microcode.Tid.TID_MODIFIER_RGB_LED_COLOR_6,
273+
microcode.Tid.TID_MODIFIER_RGB_LED_COLOR_RAINBOW,
274+
microcode.Tid.TID_MODIFIER_RGB_LED_COLOR_SPARKLE,
275+
microcode.Tid.TID_ACTUATOR_SERVO_SET_ANGLE,
276+
microcode.Tid.TID_ACTUATOR_RELAY,
277+
microcode.Tid.TID_ACTUATOR_SERVO_POWER,
273278
// editor icons
274279
"delete",
275280
"plus",
@@ -293,108 +298,108 @@ namespace docs {
293298
"note_on",
294299
"note_off",
295300
"smiley_buttons",
296-
microcode.TID_SENSOR_START_PAGE,
297-
microcode.TID_ACTUATOR_SWITCH_PAGE,
298-
microcode.TID_MODIFIER_PAGE_1,
299-
microcode.TID_MODIFIER_PAGE_2,
300-
microcode.TID_MODIFIER_PAGE_3,
301-
microcode.TID_MODIFIER_PAGE_4,
302-
microcode.TID_MODIFIER_PAGE_5,
301+
microcode.Tid.TID_SENSOR_START_PAGE,
302+
microcode.Tid.TID_ACTUATOR_SWITCH_PAGE,
303+
microcode.Tid.TID_MODIFIER_PAGE_1,
304+
microcode.Tid.TID_MODIFIER_PAGE_2,
305+
microcode.Tid.TID_MODIFIER_PAGE_3,
306+
microcode.Tid.TID_MODIFIER_PAGE_4,
307+
microcode.Tid.TID_MODIFIER_PAGE_5,
303308
// looping
304-
microcode.TID_MODIFIER_LOOP,
309+
microcode.Tid.TID_MODIFIER_LOOP,
305310

306311
// variables
307312

308-
microcode.TID_SENSOR_CUP_X_WRITTEN,
309-
microcode.TID_SENSOR_CUP_Y_WRITTEN,
310-
microcode.TID_SENSOR_CUP_Z_WRITTEN,
311-
microcode.TID_FILTER_CUP_X_READ,
312-
microcode.TID_FILTER_CUP_Y_READ,
313-
microcode.TID_FILTER_CUP_Z_READ,
314-
microcode.TID_ACTUATOR_CUP_X_ASSIGN,
315-
microcode.TID_ACTUATOR_CUP_Y_ASSIGN,
316-
microcode.TID_ACTUATOR_CUP_Z_ASSIGN,
317-
microcode.TID_MODIFIER_CUP_X_READ,
318-
microcode.TID_MODIFIER_CUP_Y_READ,
319-
microcode.TID_MODIFIER_CUP_Z_READ,
313+
microcode.Tid.TID_SENSOR_CUP_X_WRITTEN,
314+
microcode.Tid.TID_SENSOR_CUP_Y_WRITTEN,
315+
microcode.Tid.TID_SENSOR_CUP_Z_WRITTEN,
316+
microcode.Tid.TID_FILTER_CUP_X_READ,
317+
microcode.Tid.TID_FILTER_CUP_Y_READ,
318+
microcode.Tid.TID_FILTER_CUP_Z_READ,
319+
microcode.Tid.TID_ACTUATOR_CUP_X_ASSIGN,
320+
microcode.Tid.TID_ACTUATOR_CUP_Y_ASSIGN,
321+
microcode.Tid.TID_ACTUATOR_CUP_Z_ASSIGN,
322+
microcode.Tid.TID_MODIFIER_CUP_X_READ,
323+
microcode.Tid.TID_MODIFIER_CUP_Y_READ,
324+
microcode.Tid.TID_MODIFIER_CUP_Z_READ,
320325

321326
// numbers
322-
microcode.TID_MODIFIER_RANDOM_TOSS,
323-
microcode.TID_FILTER_COIN_1,
324-
microcode.TID_FILTER_COIN_2,
325-
microcode.TID_FILTER_COIN_3,
326-
microcode.TID_FILTER_COIN_4,
327-
microcode.TID_FILTER_COIN_5,
328-
microcode.TID_MODIFIER_COIN_1,
329-
microcode.TID_MODIFIER_COIN_2,
330-
microcode.TID_MODIFIER_COIN_3,
331-
microcode.TID_MODIFIER_COIN_4,
332-
microcode.TID_MODIFIER_COIN_5,
327+
microcode.Tid.TID_MODIFIER_RANDOM_TOSS,
328+
microcode.Tid.TID_FILTER_COIN_1,
329+
microcode.Tid.TID_FILTER_COIN_2,
330+
microcode.Tid.TID_FILTER_COIN_3,
331+
microcode.Tid.TID_FILTER_COIN_4,
332+
microcode.Tid.TID_FILTER_COIN_5,
333+
microcode.Tid.TID_MODIFIER_COIN_1,
334+
microcode.Tid.TID_MODIFIER_COIN_2,
335+
microcode.Tid.TID_MODIFIER_COIN_3,
336+
microcode.Tid.TID_MODIFIER_COIN_4,
337+
microcode.Tid.TID_MODIFIER_COIN_5,
333338

334339
// micro:bit sensors
335-
microcode.TID_SENSOR_ACCELEROMETER,
336-
microcode.TID_SENSOR_TIMER,
337-
microcode.TID_SENSOR_RADIO_RECEIVE,
338-
microcode.TID_SENSOR_PRESS,
339-
microcode.TID_SENSOR_RELEASE,
340-
microcode.TID_SENSOR_MICROPHONE,
341-
microcode.TID_SENSOR_TEMP,
342-
microcode.TID_SENSOR_LED_LIGHT,
343-
microcode.TID_SENSOR_LIGHT,
344-
microcode.TID_SENSOR_DISTANCE,
345-
microcode.TID_SENSOR_MOISTURE,
346-
microcode.TID_SENSOR_REFLECTED,
340+
microcode.Tid.TID_SENSOR_ACCELEROMETER,
341+
microcode.Tid.TID_SENSOR_TIMER,
342+
microcode.Tid.TID_SENSOR_RADIO_RECEIVE,
343+
microcode.Tid.TID_SENSOR_PRESS,
344+
microcode.Tid.TID_SENSOR_RELEASE,
345+
microcode.Tid.TID_SENSOR_MICROPHONE,
346+
microcode.Tid.TID_SENSOR_TEMP,
347+
microcode.Tid.TID_SENSOR_LED_LIGHT,
348+
microcode.Tid.TID_SENSOR_LIGHT,
349+
microcode.Tid.TID_SENSOR_DISTANCE,
350+
microcode.Tid.TID_SENSOR_MOISTURE,
351+
microcode.Tid.TID_SENSOR_REFLECTED,
347352

348353
// micro:bit filters
349-
microcode.TID_FILTER_LOGO,
350-
microcode.TID_FILTER_PIN_0,
351-
microcode.TID_FILTER_PIN_1,
352-
microcode.TID_FILTER_PIN_2,
353-
microcode.TID_FILTER_BUTTON_A,
354-
microcode.TID_FILTER_BUTTON_B,
355-
microcode.TID_FILTER_TIMESPAN_SHORT,
356-
microcode.TID_FILTER_TIMESPAN_LONG,
357-
microcode.TID_FILTER_TIMESPAN_VERY_LONG,
358-
microcode.TID_FILTER_TIMESPAN_RANDOM,
359-
microcode.TID_FILTER_LOUD,
360-
microcode.TID_FILTER_QUIET,
361-
microcode.TID_FILTER_TEMP_WARMER,
362-
microcode.TID_FILTER_TEMP_COLDER,
363-
microcode.TID_FILTER_ACCEL_SHAKE,
364-
microcode.TID_FILTER_ACCEL_TILT_UP,
365-
microcode.TID_FILTER_ACCEL_TILT_DOWN,
366-
microcode.TID_FILTER_ACCEL_TILT_LEFT,
367-
microcode.TID_FILTER_ACCEL_TILT_RIGHT,
368-
microcode.TID_FILTER_ACCEL_FACE_DOWN,
369-
microcode.TID_FILTER_ACCEL_FACE_UP,
370-
microcode.TID_FILTER_ON,
371-
microcode.TID_FILTER_OFF,
354+
microcode.Tid.TID_FILTER_LOGO,
355+
microcode.Tid.TID_FILTER_PIN_0,
356+
microcode.Tid.TID_FILTER_PIN_1,
357+
microcode.Tid.TID_FILTER_PIN_2,
358+
microcode.Tid.TID_FILTER_BUTTON_A,
359+
microcode.Tid.TID_FILTER_BUTTON_B,
360+
microcode.Tid.TID_FILTER_TIMESPAN_SHORT,
361+
microcode.Tid.TID_FILTER_TIMESPAN_LONG,
362+
microcode.Tid.TID_FILTER_TIMESPAN_VERY_LONG,
363+
microcode.Tid.TID_FILTER_TIMESPAN_RANDOM,
364+
microcode.Tid.TID_FILTER_LOUD,
365+
microcode.Tid.TID_FILTER_QUIET,
366+
microcode.Tid.TID_FILTER_UP,
367+
microcode.Tid.TID_FILTER_DOWN,
368+
microcode.Tid.TID_FILTER_ACCEL_SHAKE,
369+
microcode.Tid.TID_FILTER_ACCEL_TILT_UP,
370+
microcode.Tid.TID_FILTER_ACCEL_TILT_DOWN,
371+
microcode.Tid.TID_FILTER_ACCEL_TILT_LEFT,
372+
microcode.Tid.TID_FILTER_ACCEL_TILT_RIGHT,
373+
microcode.Tid.TID_FILTER_ACCEL_FACE_DOWN,
374+
microcode.Tid.TID_FILTER_ACCEL_FACE_UP,
375+
microcode.Tid.TID_FILTER_ON,
376+
microcode.Tid.TID_FILTER_OFF,
372377

373378
// micro:bit actuators
374-
microcode.TID_ACTUATOR_PAINT,
375-
microcode.TID_ACTUATOR_SHOW_NUMBER,
376-
microcode.TID_ACTUATOR_RADIO_SEND,
377-
microcode.TID_ACTUATOR_RADIO_SET_GROUP,
378-
microcode.TID_ACTUATOR_SPEAKER,
379-
microcode.TID_ACTUATOR_MUSIC,
379+
microcode.Tid.TID_ACTUATOR_PAINT,
380+
microcode.Tid.TID_ACTUATOR_SHOW_NUMBER,
381+
microcode.Tid.TID_ACTUATOR_RADIO_SEND,
382+
microcode.Tid.TID_ACTUATOR_RADIO_SET_GROUP,
383+
microcode.Tid.TID_ACTUATOR_SPEAKER,
384+
microcode.Tid.TID_ACTUATOR_MUSIC,
380385

381386
// micro:bit modifiers
382-
microcode.TID_MODIFIER_ICON_EDITOR,
383-
microcode.TID_MODIFIER_MELODY_EDITOR,
387+
microcode.Tid.TID_MODIFIER_ICON_EDITOR,
388+
microcode.Tid.TID_MODIFIER_MELODY_EDITOR,
384389

385-
microcode.TID_MODIFIER_EMOJI_GIGGLE,
386-
microcode.TID_MODIFIER_EMOJI_HAPPY,
387-
microcode.TID_MODIFIER_EMOJI_HELLO,
388-
microcode.TID_MODIFIER_EMOJI_MYSTERIOUS,
389-
microcode.TID_MODIFIER_EMOJI_SAD,
390-
microcode.TID_MODIFIER_EMOJI_SLIDE,
391-
microcode.TID_MODIFIER_EMOJI_SOARING,
392-
microcode.TID_MODIFIER_EMOJI_SPRING,
393-
microcode.TID_MODIFIER_EMOJI_TWINKLE,
394-
microcode.TID_MODIFIER_EMOJI_YAWN,
390+
microcode.Tid.TID_MODIFIER_EMOJI_GIGGLE,
391+
microcode.Tid.TID_MODIFIER_EMOJI_HAPPY,
392+
microcode.Tid.TID_MODIFIER_EMOJI_HELLO,
393+
microcode.Tid.TID_MODIFIER_EMOJI_MYSTERIOUS,
394+
microcode.Tid.TID_MODIFIER_EMOJI_SAD,
395+
microcode.Tid.TID_MODIFIER_EMOJI_SLIDE,
396+
microcode.Tid.TID_MODIFIER_EMOJI_SOARING,
397+
microcode.Tid.TID_MODIFIER_EMOJI_SPRING,
398+
microcode.Tid.TID_MODIFIER_EMOJI_TWINKLE,
399+
microcode.Tid.TID_MODIFIER_EMOJI_YAWN,
395400

396-
microcode.TID_MODIFIER_TEMP_READ,
397-
microcode.TID_MODIFIER_RADIO_VALUE,
401+
microcode.Tid.TID_MODIFIER_TEMP_READ,
402+
microcode.Tid.TID_MODIFIER_RADIO_READ,
398403
]
399404
}
400405

0 commit comments

Comments
 (0)