Skip to content

Commit

Permalink
Add necessary contracts and templates for generating instructions
Browse files Browse the repository at this point in the history 
Change-type: minor
Signed-off-by: Stevche Radevski <[email protected]>
  • Loading branch information
@sradevski
sradevski committed Feb 23, 2021
1 parent e11fb2c commit 66efdfc
Show file tree
Hide file tree
Showing 199 changed files with 4,456 additions and 112 deletions.
28 changes: 28 additions & 0 deletions blueprints/instructions.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
selector:
hw.device-type: 1
hw.storage-media: 1
sw.install-method: 1
output:
filename: instructions.md
slug: "{{this.children.hw.device-type.slug}}-{{this.children.sw.install-method.slug}}"
# We only have a single boot method per DT for now, add boot method to path once we support choosing a boot method.
path: "instructions/v1/{{this.children.hw.device-type.slug}}"
type: sw.device-type.instructions
template:
- name: instructions-device
data: >
{{import partial="connect-media-host" combination="sw.install-method+hw.device-type"}}
{{import partial="flash" combination="sw.install-method+hw.device-type"}}
{{import partial="disconnect-media-host" combination="sw.install-method+hw.device-type"}}
{{import partial="insert-media-device" combination="sw.install-method+hw.device-type"}}
{{import partial="set-boot-external" combination="hw.device-type"}}
{{import partial="remove-media-device" combination="sw.install-method+hw.device-type"}}
{{import partial="set-boot-internal" combination="hw.device-type"}}
{{import partial="connect-network" combination="hw.device-type"}}. {{import partial="power-on" combination="hw.device-type"}}
8 changes: 6 additions & 2 deletions contracts/hw.device-type/aio-3288c/contract.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
"slug": "aio-3288c",
"version": "1",
"type": "hw.device-type",
"aliases": ["aio-3288c"],
"aliases": [
"aio-3288c"
],
"name": "AIO 3288C",
"assets": {
"logo": {
Expand All @@ -13,10 +15,12 @@
"data": {
"arch": "armv7hf",
"hdmi": true,
"usb": true,
"led": false,
"connectivity": {
"bluetooth": true,
"wifi": true
"wifi": true,
"ethernet": true
},
"storage": {
"internal": false
Expand Down
4 changes: 3 additions & 1 deletion contracts/hw.device-type/am571x-evm/contract.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@
"data": {
"arch": "armv7hf",
"hdmi": true,
"usb": true,
"led": false,
"connectivity": {
"bluetooth": false
"bluetooth": false,
"ethernet": true
},
"storage": {
"internal": true
Expand Down
2 changes: 2 additions & 0 deletions contracts/hw.device-type/am571x-evm/set-boot-external.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Connect power to the {{hw.device-type.name}} and then press the SW3 Power On button.
{{import partial="shutdown-indication" combination="hw.device-type"}}.
4 changes: 3 additions & 1 deletion contracts/hw.device-type/apalis-imx6q/contract.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@
"data": {
"arch": "armv7hf",
"hdmi": true,
"usb": true,
"led": false,
"connectivity": {
"bluetooth": false
"bluetooth": false,
"ethernet": true
},
"storage": {
"internal": true
Expand Down
3 changes: 3 additions & 0 deletions contracts/hw.device-type/apalis-imx6q/set-boot-external.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Connect the carrier board to a host computer using a serial cable. (This step may differ based on what carrier board you have)
Power the module. Press SPACE when prompted by U-Boot to stop execution and run the following command `run sdboot`
{{import partial="shutdown-indication" combination="hw.device-type"}}.
4 changes: 3 additions & 1 deletion contracts/hw.device-type/artik10/contract.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@
"data": {
"arch": "armv7hf",
"hdmi": true,
"usb": true,
"led": false,
"connectivity": {
"bluetooth": false
"bluetooth": false,
"ethernet": true
},
"storage": {
"internal": true
Expand Down
1 change: 1 addition & 0 deletions contracts/hw.device-type/artik10/power-on.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Press the power switch PSW1 to the on position. Press and hold for 1 second the SW3 POWER push button.
3 changes: 3 additions & 0 deletions contracts/hw.device-type/artik10/set-boot-external.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Set SW2 dip switch to position 1:on, 2:on. Also, make sure jumpers J20 and J36 are set towards the edge of the board.
Press the power switch PSW1 to the on position. Press and hold for 1 second the SW3 POWER push button.
The device has performed a shutdown. Press the power switch PSW1 to the off position.
1 change: 1 addition & 0 deletions contracts/hw.device-type/artik10/set-boot-internal.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Set SW2 dip switch to position 1:off, 2:off.
4 changes: 3 additions & 1 deletion contracts/hw.device-type/artik5/contract.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@
"data": {
"arch": "armv7hf",
"hdmi": true,
"usb": true,
"led": false,
"connectivity": {
"bluetooth": true
"bluetooth": true,
"ethernet": true
},
"storage": {
"internal": true
Expand Down
1 change: 1 addition & 0 deletions contracts/hw.device-type/artik5/power-on.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Press the power switch PWR SW to the on position. Press and hold for 1 second the SW3 POWER push button.
3 changes: 3 additions & 0 deletions contracts/hw.device-type/artik5/set-boot-external.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Set SW2 dip switch to position 1:on, 2:on. Also, make sure jumpers J20 and J33 are set towards the edge of the board.
Press the power switch PWR SW to the on position. Press and hold for 1 second the SW3 POWER push button.
The device has performed a shutdown. Press the power switch PWR SW to the off position.
1 change: 1 addition & 0 deletions contracts/hw.device-type/artik5/set-boot-internal.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Set SW2 dip switch to position 1:off, 2:off.
4 changes: 3 additions & 1 deletion contracts/hw.device-type/artik530/contract.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@
"data": {
"arch": "armv7hf",
"hdmi": true,
"usb": true,
"led": false,
"connectivity": {
"bluetooth": true
"bluetooth": true,
"ethernet": true
},
"storage": {
"internal": true
Expand Down
1 change: 1 addition & 0 deletions contracts/hw.device-type/artik530/power-on.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Switch SW700 to the on position. Press and hold for 1 second the SW400 POWER push button.
4 changes: 4 additions & 0 deletions contracts/hw.device-type/artik530/set-boot-external.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Set SW402 dip switch to position 1:off, 2:off, 3:off, 4:on.
Switch SW700 to the on position. Press and hold for 1 second the SW400 POWER push button.
{{import partial="shutdown-indication" combination="hw.device-type"}}.
Switch SW700 to the off position.
1 change: 1 addition & 0 deletions contracts/hw.device-type/artik530/set-boot-internal.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Set SW402 dip switch to position 1:off, 2:off, 3:off, 4:off.
1 change: 1 addition & 0 deletions contracts/hw.device-type/artik530/shutdown-indication.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The device is performing a shutdown. Wait 30 seconds or until the red LED 402 is off
4 changes: 3 additions & 1 deletion contracts/hw.device-type/artik533s/contract.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@
"data": {
"arch": "armv7hf",
"hdmi": true,
"usb": true,
"led": false,
"connectivity": {
"bluetooth": true,
"wifi": true
"wifi": true,
"ethernet": true
},
"storage": {
"internal": true
Expand Down
1 change: 1 addition & 0 deletions contracts/hw.device-type/artik533s/power-on.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Switch SW700 to the on position. Press and hold for 1 second the SW400 POWER push button.
4 changes: 4 additions & 0 deletions contracts/hw.device-type/artik533s/set-boot-external.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Set SW402 dip switch to position 1:off, 2:off, 3:off, 4:on.
Switch SW700 to the on position. Press and hold for 1 second the SW400 POWER push button.
{{import partial="shutdown-indication" combination="hw.device-type"}}.
Switch SW700 to the off position.
1 change: 1 addition & 0 deletions contracts/hw.device-type/artik533s/set-boot-internal.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Set SW402 dip switch to position 1:off, 2:off, 3:off, 4:off.
1 change: 1 addition & 0 deletions contracts/hw.device-type/artik533s/shutdown-indication.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The device is performing a shutdown. Wait 30 seconds or until the red LED 402 is off
4 changes: 3 additions & 1 deletion contracts/hw.device-type/artik710/contract.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@
"data": {
"arch": "aarch64",
"hdmi": true,
"usb": true,
"led": true,
"connectivity": {
"bluetooth": true
"bluetooth": true,
"ethernet": true
},
"storage": {
"internal": true
Expand Down
1 change: 1 addition & 0 deletions contracts/hw.device-type/artik710/power-on.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Switch SW700 to the on position. Press and hold for 1 second the SW400 POWER push button.
4 changes: 4 additions & 0 deletions contracts/hw.device-type/artik710/set-boot-external.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Set SW402 dip switch to position 1:off, 2:off, 3:off, 4:on.
Switch SW700 to the on position. Press and hold for 1 second the SW400 POWER push button.
{{import partial="shutdown-indication" combination="hw.device-type"}}.
Switch SW700 to the off position.
1 change: 1 addition & 0 deletions contracts/hw.device-type/artik710/set-boot-internal.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Set SW402 dip switch to position 1:off, 2:off, 3:off, 4:off.
1 change: 1 addition & 0 deletions contracts/hw.device-type/artik710/shutdown-indication.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The device is performing a shutdown. Wait 30 seconds or until the red LED 402 is off
4 changes: 3 additions & 1 deletion contracts/hw.device-type/astro-tx2/contract.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@
"data": {
"arch": "aarch64",
"hdmi": true,
"usb": true,
"led": false,
"connectivity": {
"bluetooth": true,
"wifi": true
"wifi": true,
"ethernet": true
},
"storage": {
"internal": true
Expand Down
4 changes: 3 additions & 1 deletion contracts/hw.device-type/asus-tinker-board-s/contract.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,12 @@
"arch": "armv7hf",
"family": "family-tinkerboard",
"hdmi": true,
"usb": true,
"led": false,
"connectivity": {
"bluetooth": true,
"wifi": true
"wifi": true,
"ethernet": true
},
"storage": {
"internal": true
Expand Down
2 changes: 2 additions & 0 deletions contracts/hw.device-type/asus-tinker-board-s/set-boot-external.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Before powering up the Asus Tinker Board S, make sure that the jumper between the 5V power supply and the HDMI connector is in the MASKROM mode, as ilustrated in this link https://tinkerboarding.co.uk/wiki/index.php/Setup
{{import partial="shutdown-indication" combination="hw.device-type"}}.
1 change: 1 addition & 0 deletions contracts/hw.device-type/asus-tinker-board-s/set-boot-internal.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Before powering up the Asus Tinker Board S, make sure that the jumper between the 5V power supply and the HDMI connector is in the parking (no function) mode, as ilustrated in this link https://tinkerboarding.co.uk/wiki/index.php/Setup
4 changes: 3 additions & 1 deletion contracts/hw.device-type/asus-tinker-board/contract.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,12 @@
"arch": "armv7hf",
"family": "family-tinkerboard",
"hdmi": true,
"usb": true,
"led": false,
"connectivity": {
"bluetooth": true,
"wifi": true
"wifi": true,
"ethernet": true
},
"storage": {
"internal": false
Expand Down
4 changes: 3 additions & 1 deletion contracts/hw.device-type/bananapi-m1-plus/contract.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@
"data": {
"arch": "armv7hf",
"hdmi": true,
"usb": true,
"led": false,
"connectivity": {
"bluetooth": true,
"wifi": true
"wifi": true,
"ethernet": true
},
"storage": {
"internal": false
Expand Down
4 changes: 3 additions & 1 deletion contracts/hw.device-type/beagleboard-xm/contract.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@
"data": {
"arch": "armv7hf",
"hdmi": true,
"usb": true,
"led": true,
"connectivity": {
"bluetooth": false,
"wifi": false
"wifi": false,
"ethernet": true
},
"storage": {
"internal": false
Expand Down
8 changes: 6 additions & 2 deletions contracts/hw.device-type/beaglebone-black/contract.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
"slug": "beaglebone-black",
"version": "1",
"type": "hw.device-type",
"aliases": ["beaglebone"],
"aliases": [
"beaglebone"
],
"name": "BeagleBone Black",
"assets": {
"logo": {
Expand All @@ -13,10 +15,12 @@
"data": {
"arch": "armv7hf",
"hdmi": true,
"usb": true,
"led": true,
"connectivity": {
"bluetooth": false,
"wifi": false
"wifi": false,
"ethernet": true
},
"storage": {
"internal": true
Expand Down
2 changes: 2 additions & 0 deletions contracts/hw.device-type/beaglebone-black/set-boot-external.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Power up the BeagleBone Black while holding down the small button near the SD slot. You need to keep it pressed until the blue LEDs start flashing wildly.
{{import partial="shutdown-indication" combination="hw.device-type"}}.
4 changes: 3 additions & 1 deletion contracts/hw.device-type/beaglebone-green-gateway/contract.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@
"arch": "armv7hf",
"hdmi": false,
"led": true,
"usb": true,
"connectivity": {
"bluetooth": true,
"wifi": true
"wifi": true,
"ethernet": true
},
"storage": {
"internal": true
Expand Down
4 changes: 3 additions & 1 deletion contracts/hw.device-type/beaglebone-green-wifi/contract.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@
"data": {
"arch": "armv7hf",
"hdmi": false,
"usb": true,
"led": true,
"connectivity": {
"bluetooth": true,
"wifi": true
"wifi": true,
"ethernet": true
},
"storage": {
"internal": true
Expand Down
2 changes: 2 additions & 0 deletions contracts/hw.device-type/beaglebone-green-wifi/set-boot-external.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Power up the BeagleBone Green while holding down the small button near the SD slot. You need to keep it pressed until the blue LEDs start flashing wildly.
{{import partial="shutdown-indication" combination="hw.device-type"}}.
1 change: 1 addition & 0 deletions contracts/hw.device-type/beaglebone-green-wifi/shutdown-indication.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Wait 5 seconds after the blue leds stopped flashing wildly, then remove power from the board. On some boards the leds will shut down completely.
6 changes: 4 additions & 2 deletions contracts/hw.device-type/beaglebone-green/contract.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@
},
"data": {
"arch": "armv7hf",
"led": true,
"hdmi": false,
"usb": true,
"led": true,
"connectivity": {
"bluetooth": false,
"wifi": false
"wifi": false,
"ethernet": true
},
"storage": {
"internal": true
Expand Down
2 changes: 2 additions & 0 deletions contracts/hw.device-type/beaglebone-green/set-boot-external.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Power up the BeagleBone Green while holding down the small button near the SD slot. You need to keep it pressed until the blue LEDs start flashing wildly.
{{import partial="shutdown-indication" combination="hw.device-type"}}.
6 changes: 4 additions & 2 deletions contracts/hw.device-type/beaglebone-pocket/contract.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@
},
"data": {
"arch": "armv7hf",
"led": true,
"hdmi": false,
"usb": true,
"led": true,
"connectivity": {
"bluetooth": false,
"wifi": false
"wifi": false,
"ethernet": true
},
"storage": {
"internal": false
Expand Down
Loading

0 comments on commit 66efdfc

Please sign in to comment.