Skip to content

Commit 4bed3ce

Browse files
gfwilliamsgfwilliams
committed
Move app JSON into individual metadata files
1 parent af751cb commit 4bed3ce

File tree

30 files changed

+527
-333
lines changed

30 files changed

+527
-333
lines changed

‎README.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
Espruino App Loader (and Apps)
22
==============================
33

4-
**THIS IS BETA:** We're still trying things out, so there isn't a great
5-
app selection and things are liable to change.
6-
74
[![Build Status](https://github.com/espruino/EspruinoApps/actions/workflows/nodejs.yml/badge.svg)](https://github.com/espruino/EspruinoApps/actions/workflows/nodejs.yml)
85

96
<!-- * Try the **release version** at [espruino.com/apps](https://espruino.com/apps) -->
@@ -15,12 +12,19 @@ and that it is not licensed in another way that would make this impossible.
1512

1613
## How does it work?
1714

18-
* A list of apps is in `apps.json`
19-
* Each element references an app in `apps/<id>` which is uploaded
15+
* Apps are in the `apps` folder, and each app has `metadata.json` file describing it (the `id` must match the folder name)
2016
* When it starts, EspruinoAppLoader checks the JSON and compares
2117
it with the files it sees in storage.
2218
* To upload an app, EspruinoAppLoader checks the files that are
23-
listed in `apps.json`, loads them, and sends them over Web Bluetooth.
19+
listed in `metadata.json`, loads them, and sends them over Web Bluetooth.
20+
21+
This is a cut-down version of what's used in https://banglejs.com/apps
22+
for Bangle.js apps, so much of the advice in https://github.com/espruino/BangleApps/blob/master/README.md
23+
applies.
24+
25+
**However** because we're only handling one app at a time, we don't write the app
26+
into a file called `appid.app.js`, but instead into `.bootcde` which is the file
27+
that the Espruino writes into when writing "To Flash" (for more info see https://www.espruino.com/Saving)
2428

2529
## Credits
2630

‎apps.json

+8-327
Original file line numberDiff line numberDiff line change
@@ -1,329 +1,10 @@
1+
---
2+
layout: none
3+
---
4+
{%- assign apps = site.static_files | where: "name", "metadata.json" -%}
15
[
2-
{ "id": "blehidkey",
3-
"name": "Bluetooth HID key",
4-
"icon": "icon.png",
5-
"version":"0.01",
6-
"description": "Make device appear as a HID keyboard. When BTN1 is pressed send Enter",
7-
"tags": "bluetooth",
8-
"needsFeatures":["BLE","BLEHID"],
9-
"storage": [
10-
{"name":".bootcde","url":"app.js"}
11-
]
12-
},
13-
{ "id": "bledooropencounter",
14-
"name": "Bluetooth Door Opening Counter",
15-
"icon": "icon.png",
16-
"version":"0.02",
17-
"description": "Uses the magnetometer to detect when a magnet is nearby (door closed) or not (door open), and advertises the number of door openings.",
18-
"tags": "bluetooth",
19-
"readme": "README.md",
20-
"needsFeatures":["BLE"],
21-
"storage": [
22-
{"name":".bootcde","url":"app.js"}
23-
]
24-
},
25-
{ "id": "bleeddystone",
26-
"name": "Bluetooth Eddystone Beacon",
27-
"icon": "icon.png",
28-
"version":"0.01",
29-
"description": "Configure your device to be an [Eddystone beacon](https://github.com/google/eddystone)",
30-
"tags": "bluetooth",
31-
"custom": "custom.html",
32-
"needsFeatures":["BLE"],
33-
"storage": [
34-
{"name":".bootcde"}
35-
]
36-
},
37-
{ "id": "nfcurl",
38-
"name": "NFC URL",
39-
"icon": "icon.png",
40-
"version":"0.01",
41-
"description": "Configure your Espruino device with a specific URL",
42-
"tags": "nfc,tool",
43-
"custom": "custom.html",
44-
"needsFeatures":["NFC"],
45-
"storage": [
46-
{"name":".bootcde"}
47-
]
48-
},
49-
{ "id": "openhaystack",
50-
"name": "OpenHaystack (AirTag)",
51-
"icon": "icon.png",
52-
"version":"0.01",
53-
"description": "Copy a base64 key from https://github.com/seemoo-lab/openhaystack and make your device trackable as if it's an AirTag",
54-
"tags": "openhaystack,bluetooth,ble,tracking,airtag",
55-
"custom": "custom.html",
56-
"readme": "README.md",
57-
"needsFeatures":["BLE"],
58-
"storage": [
59-
{"name":".bootcde"}
60-
]
61-
},
62-
{ "id": "blescanner",
63-
"name": "Bluetooth Scanner",
64-
"icon": "icon.png",
65-
"version":"0.02",
66-
"description": "Scans for Bluetooth LE devices and shows their names on the screen",
67-
"tags": "bluetooth",
68-
"needsFeatures":["BLE","GRAPHICS"],
69-
"storage": [
70-
{"name":".bootcde","url":"app.js"}
71-
]
72-
},
73-
{ "id": "bletemperature",
74-
"name": "Bluetooth Temperature Beacon",
75-
"icon": "icon.png",
76-
"version":"0.03",
77-
"description": "Turns the given device into a Bluetooth Temperature sensor that advertises the current temperature on Bluetooth UUID 0x1809 ('Health Thermometer'). The device won't be connectable again until it is rebooted without loading saved code.",
78-
"tags": "bluetooth",
79-
"needsFeatures":["BLE"],
80-
"storage": [
81-
{"name":".bootcde","url":"app.js"}
82-
]
83-
},
84-
{ "id": "pixlmulticolbadge",
85-
"name": "Pixl.js Multicolor Badge",
86-
"icon": "icon.png",
87-
"version":"0.02",
88-
"description": "Programs a [Pixl.js Multicolor Badge](http://www.espruino.com/Pixl.js+Multicolour) to display your name, the time, and to include Flappy Bird and T-Rex games.",
89-
"tags": "bluetooth,nfc",
90-
"custom": "custom.html",
91-
"needsFeatures":["BLE","NFC","GRAPHICS"],
92-
"storage": [
93-
{"name":".boot0"},
94-
{"name":".bootcde","url":"app.js"}
95-
]
96-
},
97-
{ "id": "pixlbadge",
98-
"name": "Pixl.js Badge",
99-
"icon": "icon.png",
100-
"version":"0.01",
101-
"description": "Programs a [Pixl.js](http://www.espruino.com/Pixl.js) to display your name, the time, and to include Flappy Bird and T-Rex games.",
102-
"tags": "bluetooth,nfc",
103-
"custom": "custom.html",
104-
"needsFeatures":["BLE","NFC","GRAPHICS"],
105-
"storage": [
106-
{"name":".boot0"},
107-
{"name":".bootcde","url":"app.js"}
108-
]
109-
},
110-
{ "id": "trex",
111-
"name": "T-Rex (Dinosaur game)",
112-
"icon": "icon.png",
113-
"version":"0.01",
114-
"description": "T-Rex game in the style of Chrome's offline game",
115-
"tags": "game",
116-
"needsFeatures":["GRAPHICS"],
117-
"storage": [
118-
{"name":".bootcde","url":"app.js"}
119-
]
120-
},
121-
{ "id": "lunarlander",
122-
"name": "Lunar Lander game",
123-
"icon": "icon.png",
124-
"version":"0.01",
125-
"description": "Simple Lunar lander game using BTN2/3 to steer and BTN4 for thrust. Designed for 128x64 screens.",
126-
"tags": "game",
127-
"needsFeatures":["GRAPHICS"],
128-
"storage": [
129-
{"name":".bootcde","url":"app.js"}
130-
]
131-
},
132-
{ "id": "breakout",
133-
"name": "Breakout game",
134-
"icon": "icon.png",
135-
"version":"0.01",
136-
"description": "Simple breakout game using BTN1/BTN4 to control the bat. Designed for 128x64 screens.",
137-
"tags": "game",
138-
"needsFeatures":["GRAPHICS"],
139-
"storage": [
140-
{"name":".bootcde","url":"app.js"}
141-
]
142-
},
143-
{ "id": "simpleclock",
144-
"name": "Simple Clock",
145-
"icon": "icon.png",
146-
"version":"0.01",
147-
"description": "Simple 7 segment clock that will scale to fit your display size",
148-
"tags": "clock",
149-
"needsFeatures":["GRAPHICS"],
150-
"storage": [
151-
{"name":".bootcde","url":"app.js"}
152-
]
153-
},
154-
{ "id": "simpletimer",
155-
"name": "Countdown Timer",
156-
"icon": "icon.png",
157-
"version":"0.01",
158-
"description": "Count down from a predefined time. Either displays the countdown on the display, or flashes LEDs to show coundown state. BTN1 starts & stops.",
159-
"tags": "clock",
160-
"custom": "custom.html",
161-
"storage": [
162-
{"name":".bootcde"}
163-
]
164-
},
165-
{ "id": "bletemplogger",
166-
"name": "Bluetooth Temperature Logger",
167-
"icon": "icon.png",
168-
"version":"0.02",
169-
"description": "Log temperature every half hour. Connect again, choose 'My Apps', then 'Upload', and view the data.",
170-
"tags": "bluetooth",
171-
"needsFeatures":["BLE"],
172-
"interface": "interface.html",
173-
"storage": [
174-
{"name":".bootcde","url":"app.js"}
175-
]
176-
},
177-
{ "id": "blechargemonitor",
178-
"name": "Bluetooth Battery Charge Monitor",
179-
"icon": "icon.png",
180-
"version":"0.02",
181-
"description": "Connect voltage to D31 and current to D29. The values will be logged and can be viewed in the 'interface' app",
182-
"tags": "bluetooth",
183-
"needsFeatures":["BLE"],
184-
"interface": "interface.html",
185-
"storage": [
186-
{"name":".bootcde","url":"app.js"}
187-
]
188-
},
189-
{ "id": "qrcode",
190-
"name": "Custom QR Code",
191-
"icon": "app.png",
192-
"version":"0.02",
193-
"description": "Use this to upload a customised (64x64) QR code to a device with a screen",
194-
"tags": "qrcode",
195-
"needsFeatures":["GRAPHICS"],
196-
"custom": "custom.html",
197-
"storage": [
198-
{"name":".bootcde"}
199-
]
200-
},
201-
{ "id": "puckrotate",
202-
"name": "Puck.js rotation advertising",
203-
"icon": "icon.png",
204-
"version":"0.01",
205-
"description": "Uses Puck.js to detect rotation, and advertises it over Bluetooth as JSON",
206-
"tags": "bluetooth",
207-
"readme": "README.md",
208-
"needsFeatures":["BLE","GYRO","ACCEL"],
209-
"storage": [
210-
{"name":".bootcde","url":"app.js"}
211-
]
212-
},
213-
{ "id": "pucksiren",
214-
"name": "Puck.js Siren",
215-
"icon": "icon.png",
216-
"version":"0.01",
217-
"description": "Attach LEDs and speaker as in http://www.espruino.com/Puck.js+Duplo+Siren, upload this code and your Puck will flash the lights and make sound whenever moved!",
218-
"tags": "",
219-
"needsFeatures":["BLE","ACCEL"],
220-
"storage": [
221-
{"name":".bootcde","url":"app.js"}
222-
]
223-
},
224-
{ "id": "tilthydro",
225-
"name": "Tilt Hydrometer Display",
226-
"icon": "icon.png",
227-
"version":"0.01",
228-
"description": "A display for the [Tilt Hydrometer](https://tilthydrometer.com/) - [more info here](http://www.espruino.com/Tilt+Hydrometer+Display)",
229-
"tags": "",
230-
"needsFeatures":["BLE","GRAPHICS"],
231-
"storage": [
232-
{"name":".bootcde","url":"app.js"}
233-
]
234-
},
235-
{ "id": "tiltrepeater",
236-
"name": "Tilt Hydrometer Repeater",
237-
"icon": "icon.png",
238-
"version":"0.01",
239-
"description": "A repeater/signal booster for the [Tilt Hydrometer](https://tilthydrometer.com/) - [more info here](http://www.espruino.com/Tilt+Repeater)",
240-
"tags": "",
241-
"needsFeatures":["BLE"],
242-
"storage": [
243-
{"name":".bootcde","url":"app.js"}
244-
]
245-
},
246-
{ "id": "bleeverything",
247-
"name": "Bluetooth Advertiser - Everything!",
248-
"icon": "icon.png",
249-
"version":"0.01",
250-
"description": "Upload this code and your Puck will advertise temperature (f), battery percentage, LED states, Voltage and Light data each minute. It will also advertise button, acceleration, magnetic field and nfc field state data when it senses a change. You can use EspruinoHub and NodeRed MQTT In nodes to record and process the advertised data.",
251-
"tags": "bluetooth,nfc",
252-
"needsFeatures":["BLE","ACCEL","GYRO","NFC"],
253-
"storage": [
254-
{"name":".bootcde","url":"app.js"}
255-
]
256-
},
257-
{ "id": "bthome_button",
258-
"name": "BTHome Button",
259-
"icon": "icon.png",
260-
"version":"0.02",
261-
"description": "Turn your device into a BTHome/Home Assistant compatible button",
262-
"tags": "bluetooth,homeassistant",
263-
"readme": "README.md",
264-
"needsFeatures":["BLE"],
265-
"storage": [
266-
{"name":".bootcde","url":"app.js"}
267-
]
268-
},
269-
{ "id": "bthome_door",
270-
"name": "BTHome Door Sensor",
271-
"icon": "icon.png",
272-
"version":"0.01",
273-
"description": "Turn your Puck.js into a BTHome/Home Assistant compatible door open detector",
274-
"tags": "bluetooth,homeassistant,door",
275-
"readme": "README.md",
276-
"needsFeatures":["BLE","MAG"],
277-
"storage": [
278-
{"name":".bootcde","url":"app.js"}
279-
]
280-
},
281-
{ "id": "bthome_energy",
282-
"name": "BTHome Energy Monitor",
283-
"icon": "icon.png",
284-
"version":"0.01",
285-
"description": "Turn your Espruino device into a BTHome/Home Assistant compatible energy monitor by sensing flashes from your electricty meter (needs an LDR wired between D1 and D2)",
286-
"tags": "bluetooth,homeassistant,energy,power,electricity,sensor",
287-
"readme": "README.md",
288-
"needsFeatures":["BLE"],
289-
"storage": [
290-
{"name":".bootcde","url":"app.js"}
291-
]
292-
},
293-
{ "id": "bthome_vibration",
294-
"name": "BTHome Vibration Sensor",
295-
"icon": "icon.png",
296-
"version":"0.01",
297-
"description": "Turn your Puck.js into a BTHome/Home Assistant compatible vibration/movement sensor. When it moves, it'll send that information as a BTHome packet which will then appear in HomeAssistant.",
298-
"tags": "bluetooth,homeassistant,vibration,movement,sensor",
299-
"readme": "README.md",
300-
"needsFeatures":["BLE","ACCEL"],
301-
"storage": [
302-
{"name":".bootcde","url":"app.js"}
303-
]
304-
},
305-
{ "id": "ha_led",
306-
"name": "Home Assistant Bluetooth LED",
307-
"icon": "icon.png",
308-
"version":"0.01",
309-
"description": "Turn your Bluetooth Espruino device into a LED that can be controlled from Home assistant",
310-
"tags": "bluetooth,homeassistant,LED",
311-
"readme": "README.md",
312-
"needsFeatures":["BLE","RGBLED"],
313-
"storage": [
314-
{"name":".bootcde","url":"app.js"}
315-
]
316-
},
317-
{ "id": "knobbutton",
318-
"name": "Knob Button",
319-
"icon": "icon.png",
320-
"version":"0.01",
321-
"description": "Use the Puck.js (v2) as an anywhere knob: push the button to transmit the angle of rotation in BLE advertising packets.",
322-
"tags": "bluetooth",
323-
"readme": "README.md",
324-
"needsFeatures":["BLE","ACCEL"],
325-
"storage": [
326-
{"name":".bootcde","url":"app.js"}
327-
]
328-
}
6+
{%- include_relative {{ apps.first.path }} -%}
7+
{%- for app in apps offset:1 -%}
8+
,{%- include_relative {{ app.path }} -%}
9+
{%- endfor -%}
32910
]

‎apps/blechargemonitor/metadata.json

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"id": "blechargemonitor",
3+
"name": "Bluetooth Battery Charge Monitor",
4+
"icon": "icon.png",
5+
"version": "0.02",
6+
"description": "Connect voltage to D31 and current to D29. The values will be logged and can be viewed in the 'interface' app",
7+
"tags": "bluetooth",
8+
"needsFeatures": [
9+
"BLE"
10+
],
11+
"interface": "interface.html",
12+
"storage": [
13+
{
14+
"name": ".bootcde",
15+
"url": "app.js"
16+
}
17+
]
18+
}

0 commit comments

Comments
 (0)