Skip to content

Commit

Permalink
add instruction partials to device contracts
Browse files Browse the repository at this point in the history
Change-type: minor
Signed-off-by: Micah Halter <[email protected]>
  • Loading branch information
mehalter committed Apr 2, 2021
1 parent 66efdfc commit c16ee36
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 0 deletions.
15 changes: 15 additions & 0 deletions contracts/hw.device-type/beaglebone-black/contract.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,21 @@
"media": {
"installation": "sdcard"
},
"installation": {
"media": "SD card",
"method": "externalFlash"
},
"is_private": false
},
"partials": {
"insertMediaDevice": ["Insert the freshly burn {{data.installation.media}} into the {{name}}"],
"bootDeviceExternal": [
"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.",
"<strong role=\"alert\">Warning!</strong> This will also completely erase internal storage media, so please make a backup first."
],
"waitForFlash": ["Wait for the device to finish flashing and shutdown. Please wait until all LEDs are off."],
"removeExternalMedia": ["Remove the balenaOS {{data.installation.media}}."],
"bootDeviceInternal": [],
"bootDevice": ["Remove and re-connect power to the board."]
}
}
11 changes: 11 additions & 0 deletions contracts/hw.device-type/fincm3/contract.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,17 @@
"media": {
"installation": "dfu"
},
"installation": {
"method": "internalFlash"
},
"is_private": false
},
"partials": {
"connectDevice": [
"While not having the Fin board powered, connect your system to the board's DBG/PRG port via a micro-USB cable.",
"<em>Note: for the Fin v1.1, only power the Fin from the PRG port for flashing. For the Fin v1.0, power on the Fin by attaching power to either the Barrel or the Phoenix connector.</em>"
],
"disconnectDevice": ["When flashing is complete, power off the board by detaching the power if connected, and unplug the DGB micro-USB cable."],
"bootDevice": ["Remove and re-connect power to the board."]
}
}
16 changes: 16 additions & 0 deletions contracts/hw.device-type/intel-edison/contract.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,22 @@
"media": {
"installation": "dfu"
},
"installation": {
"method": "other"
},
"is_private": false
},
"partials": {
"instructions": [
"Install <code>dfu-util</code> and <code>coreutils</code> from your distributions repos. For example, for Ubuntu: <code>apt-get install dfu-util coreutils</code>",
"Unplug the Intel Edison board from your system",
"Unzip the downloaded Device OS file.",
"Execute the following from the unzipped directory: <code>sudo ./flashall.sh</code>",
"If you have trouble executing, you may need to modify the file permissions first: <code> sudo chmod +x ./flashall.sh</code>"
],
"bootDevice": [
"Plug the Intel Edison as per the instructions on your terminal.",
"You can check the progress of the provisioning on your terminal."
]
}
}
7 changes: 7 additions & 0 deletions contracts/hw.device-type/raspberry-pi/contract.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,13 @@
"media": {
"installation": "sdcard"
},
"installation": {
"method": "externalBoot"
},
"is_private": false
},
"partials": {
"insertMediaDevice": ["Insert the freshly burn SD card into the {{name}}."],
"bootDevice": ["Connect your {{name}} to the internet, then power it up."]
}
}

0 comments on commit c16ee36

Please sign in to comment.