Add instruction partials to etcher supported device types

Change-type: minor Signed-off-by: Micah Halter <micah@balena.io>
balena-io · Apr 21, 2022 · 244a56d · 244a56d
1 parent 22692d1
commit 244a56d
Show file tree

Hide file tree

Showing 58 changed files with 518 additions and 1 deletion.
diff --git a/contracts/hw.device-type/aio-3288c/contract.json b/contracts/hw.device-type/aio-3288c/contract.json
@@ -24,6 +24,12 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalBoot"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDevice": ["Connect power to the {{name}}"]
   }
 }
diff --git a/contracts/hw.device-type/astro-tx2/contract.json b/contracts/hw.device-type/astro-tx2/contract.json
@@ -24,6 +24,14 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalFlash"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDeviceExternal": ["Connect power to the {{name}}"],
+    "flashIndicator": ["all LEDs are off"],
+    "bootDevice": ["Remove and re-connect power to the {{name}}"]
   }
 }
diff --git a/contracts/hw.device-type/asus-tinker-board-s/contract.json b/contracts/hw.device-type/asus-tinker-board-s/contract.json
@@ -25,6 +25,20 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalFlash"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDeviceExternal": [
+      "Make sure that the jumper between the 5V power supply and the HDMI connect is in the MASKROM mode as illustrated on the <a href=\"https://tinkerboarding.co.uk/wiki/index.php/Setup\">Tinker Board Wiki</a>",
+      "Connect power to the {{name}}"
+    ],
+    "flashIndicator": ["all LEDs are off"],
+    "bootDevice": [
+      "Make sure that the jumper between the 5V power supply and the HDMI connect is in the parking (no function) mode as illustrated on the <a href=\"https://tinkerboarding.co.uk/wiki/index.php/Setup\">Tinker Board Wiki</a>",
+      "Remove and re-connect power to the {{name}}"
+    ]
   }
 }
diff --git a/contracts/hw.device-type/asus-tinker-board/contract.json b/contracts/hw.device-type/asus-tinker-board/contract.json
@@ -25,6 +25,12 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalBoot"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDevice": ["Connect power to the {{name}}"]
   }
 }
diff --git a/contracts/hw.device-type/asus-tinker-edge-t/contract.json b/contracts/hw.device-type/asus-tinker-edge-t/contract.json
@@ -24,6 +24,20 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalFlash"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDeviceExternal": [
+      "Set the BOOT_SELECT switch to the SD-CARD position",
+      "Connect power to the {{name}}"
+    ],
+    "flashIndicator": ["all LEDs are off"],
+    "bootDevice": [
+      "Set the BOOT_SELECT switch to the eMMC position",
+      "Remove and re-connect power to the {{name}}"
+    ]
   }
 }
diff --git a/contracts/hw.device-type/bananapi-m1-plus/contract.json b/contracts/hw.device-type/bananapi-m1-plus/contract.json
@@ -24,6 +24,12 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalBoot"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDevice": ["Connect power to the {{name}}"]
   }
 }
diff --git a/contracts/hw.device-type/beagleboard-xm/contract.json b/contracts/hw.device-type/beagleboard-xm/contract.json
@@ -24,6 +24,12 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalBoot"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDevice": ["Connect power to the {{name}}"]
   }
 }
diff --git a/contracts/hw.device-type/beaglebone-black/contract.json b/contracts/hw.device-type/beaglebone-black/contract.json
@@ -24,6 +24,14 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalFlash"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDeviceExternal": ["Power up the {{name}} while holding down the small button near the SD slot. You need to keep it pressed until the blue LEDs start flashing wildly."],
+    "flashIndicator": ["all LEDs are off"],
+    "bootDevice": ["Remove and re-connect power to the {{name}}"]
   }
 }
diff --git a/contracts/hw.device-type/beaglebone-green-gateway/contract.json b/contracts/hw.device-type/beaglebone-green-gateway/contract.json
@@ -24,6 +24,14 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalFlash"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDeviceExternal": ["Power up the {{name}} while holding down the small button near the SD slot. You need to keep it pressed until the blue LEDs start flashing wildly."],
+    "flashIndicator": ["5 seconds after the LEDs have stopped flashing wildly"],
+    "bootDevice": ["Remove and re-connect power to the {{name}}"]
   }
 }
diff --git a/contracts/hw.device-type/beaglebone-green-wifi/contract.json b/contracts/hw.device-type/beaglebone-green-wifi/contract.json
@@ -24,6 +24,14 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalFlash"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDeviceExternal": ["Power up the {{name}} while holding down the small button near the SD slot. You need to keep it pressed until the blue LEDs start flashing wildly."],
+    "flashIndicator": ["5 seconds after the LEDs have stopped flashing wildly"],
+    "bootDevice": ["Remove and re-connect power to the {{name}}"]
   }
 }
diff --git a/contracts/hw.device-type/beaglebone-green/contract.json b/contracts/hw.device-type/beaglebone-green/contract.json
@@ -24,6 +24,14 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalFlash"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDeviceExternal": ["Power up the {{name}} while holding down the small button near the SD slot. You need to keep it pressed until the blue LEDs start flashing wildly."],
+    "flashIndicator": ["all LEDs are off"],
+    "bootDevice": ["Remove and re-connect power to the {{name}}"]
   }
 }
diff --git a/contracts/hw.device-type/beaglebone-pocket/contract.json b/contracts/hw.device-type/beaglebone-pocket/contract.json
@@ -24,6 +24,12 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalBoot"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDevice": ["Connect power to the {{name}}"]
   }
 }
diff --git a/contracts/hw.device-type/blackboard-tx2/contract.json b/contracts/hw.device-type/blackboard-tx2/contract.json
@@ -24,6 +24,17 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalFlash"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDeviceExternal": [
+      "Connect power to the {{name}}",
+      "Press and hold the POWER push button for 1 second"
+    ],
+    "flashIndicator": ["all LEDs are off"],
+    "bootDevice": ["Remove and re-connect power to the {{name}}"]
   }
 }
diff --git a/contracts/hw.device-type/ccimx8x-sbc-pro/contract.json b/contracts/hw.device-type/ccimx8x-sbc-pro/contract.json
@@ -24,6 +24,21 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalFlash"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDeviceExternal": [
+      "Make sure your {{name}} contains a system-on-module with a 2GB i.MX8X quad B0 system-on-chip. Different module variants are not supported and will not boot.",
+      "Configure the boot microswitches (S2) for SD boot (SW1 OFF and SW2 ON)",
+      "Connect power to the {{name}}"
+    ],
+    "flashIndicator": ["all LEDs are off"],
+    "bootDevice": [
+      "Configure the boot microswitches (S2) for internal (eMMC) boot (SW1 OFF and SW2 OFF)",
+      "Remove and re-connect power to the {{name}}"
+    ]
   }
 }
diff --git a/contracts/hw.device-type/cl-som-imx8/contract.json b/contracts/hw.device-type/cl-som-imx8/contract.json
@@ -24,6 +24,18 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalFlash"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDeviceExternal": [
+      "Connect power to the {{name}}",
+      "Press and hold SW5 followed by SW6",
+      "Release SW5 followed by SW6"
+    ],
+    "flashIndicator": ["all LEDs are off"],
+    "bootDevice": ["Remove and re-connect power to the {{name}}"]
   }
 }
diff --git a/contracts/hw.device-type/coral-dev/contract.json b/contracts/hw.device-type/coral-dev/contract.json
@@ -24,6 +24,20 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalFlash"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDeviceExternal": [
+      "Set the BOOT_SELECT switch to the SD-CARD position",
+      "Connect power to the {{name}}"
+    ],
+    "flashIndicator": ["all LEDs are off"],
+    "bootDevice": [
+      "Set the BOOT_SELECT switch to the SD-CARD position",
+      "Remove and re-connect power to the {{name}}"
+    ]
   }
 }
diff --git a/contracts/hw.device-type/etcher-pro/contract.json b/contracts/hw.device-type/etcher-pro/contract.json
@@ -23,6 +23,20 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalFlash"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDeviceExternal": [
+      "Set the DSW1 switch to the ON position",
+      "Connect power to the {{name}}"
+    ],
+    "flashIndicator": ["all LEDs are off"],
+    "bootDevice": [
+      "Set the DSW1 switch to the OFF position",
+      "Remove and re-connect power to the {{name}}"
+    ]
   }
 }
diff --git a/contracts/hw.device-type/fincm3/contract.json b/contracts/hw.device-type/fincm3/contract.json
@@ -24,6 +24,17 @@
     "media": {
       "installation": "dfu"
     },
+    "installation": {
+      "method": "internalFlash"
+    },
     "is_private": false
+  },
+  "partials": {
+    "connectDevice": [
+      "While not having the {{name}} board powered, connect your system to the board's DBG/PRG port via a micro-USB cable.",
+      "<em>Note: for the {{name}} v1.1, only power the board from the PRG port for flashing. For the {{name}} v1.0, power on the board by attaching power to either the Barrel or the Phoenix connector.</em>"
+    ],
+    "disconnectDevice": ["Power off the {{name}} by detaching the power if connected and unplug the DGB micro-USB cable."],
+    "bootDevice": ["Remove and re-connect power to the {{name}}"]
   }
 }
diff --git a/contracts/hw.device-type/firefly-rk3288/contract.json b/contracts/hw.device-type/firefly-rk3288/contract.json
@@ -24,6 +24,12 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalBoot"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDevice": ["Connect power to the {{name}}"]
   }
 }
diff --git a/contracts/hw.device-type/imx6ul-var-dart/contract.json b/contracts/hw.device-type/imx6ul-var-dart/contract.json
@@ -24,6 +24,18 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalFlash"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDeviceExternal": [
+      "Connect power to the {{name}}",
+      "Press and hold the SW2 button followed by the SW1 button",
+      "Release the SW1 button followed by the SW2 button"
+    ],
+    "flashIndicator": ["all LEDs are off"],
+    "bootDevice": ["Remove and re-connect power to the {{name}}"]
   }
 }
diff --git a/contracts/hw.device-type/imx7-var-som/contract.json b/contracts/hw.device-type/imx7-var-som/contract.json
@@ -24,6 +24,20 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalFlash"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDeviceExternal": [
+      "Set the SW1 BOOT-SELECT switch to SD-CARD",
+      "Connect power to the {{name}}"
+    ],
+    "flashIndicator": ["all LEDs are off"],
+    "bootDevice": [
+      "Set the SW1 BOOT-SELECT switch to eMMC",
+      "Remove and re-connect power to the {{name}}"
+    ]
   }
 }
diff --git a/contracts/hw.device-type/imx8m-var-dart/contract.json b/contracts/hw.device-type/imx8m-var-dart/contract.json
@@ -24,6 +24,20 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalFlash"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDeviceExternal": [
+      "Set the SW7 BOOT-SELECT switch to SD-CARD",
+      "Connect power to the {{name}}"
+    ],
+    "flashIndicator": ["all LEDs are off"],
+    "bootDevice": [
+      "Set the SW7 BOOT-SELECT switch to eMMC",
+      "Remove and re-connect power to the {{name}}"
+    ]
   }
 }
diff --git a/contracts/hw.device-type/imx8mm-var-dart/contract.json b/contracts/hw.device-type/imx8mm-var-dart/contract.json
@@ -24,6 +24,20 @@
     "media": {
       "installation": "sdcard"
     },
+    "installation": {
+      "method": "externalFlash"
+    },
     "is_private": false
+  },
+  "partials": {
+    "bootDeviceExternal": [
+      "Set the SW7 BOOT-SELECT switch to EXT",
+      "Connect power to the {{name}}"
+    ],
+    "flashIndicator": ["all LEDs are off"],
+    "bootDevice": [
+      "Set the SW7 BOOT-SELECT switch to INT",
+      "Remove and re-connect power to the {{name}}"
+    ]
   }
 }