docs: Corrected documentation related to Banana BPI hardware
All checks were successful
arcad/emissary-firmware/pipeline/pr-master This commit looks good

This commit is contained in:
lseys 2023-08-28 11:04:37 +02:00
parent 666a180c5d
commit 91365ec4ac
2 changed files with 43 additions and 36 deletions

View File

@ -18,19 +18,19 @@
## Installation
Par défaut la borne est sans OS, donc impossible de flasher selon la méthode conventionnel.
Par défaut, la borne est livrée sans système d'exploitation, ce qui rend impossible la procédure de flashage conventionnelle.
bpi fournit un soft permettant de prendre un .img et de le mettre en place dans une carte SD.
BPI fournit un logiciel qui permet de prendre un fichier .img et de le mettre en place sur une carte SD.
### Installation bpi-tools
Il est conseillé d'installer pv auparavant pour plus de commodité. (disponibilité ubunut et manjaro validé)
Il est recommandé d'installer préalablement pv pour plus de commodité. (Disponible et validé sur Ubuntu et Manjaro)
```Shell
apt-get install pv
```
Installer bpi-tools sur votre machine, si vous ne pouvez accéder à l'url via curl, ce rendre sur le repo bpi-tools et le faire manuellement.
Pour installer bpi-tools sur votre machine, si vous ne pouvez pas accéder à l'URL via curl, rendez-vous sur le dépôt de bpi-tools et effectuez le processus manuellement.
```Shell
curl -sL https://github.com/BPI-SINOVOIP/bpi-tools/raw/master/bpi-tools | sudo -E bash
@ -38,21 +38,21 @@ curl -sL https://github.com/BPI-SINOVOIP/bpi-tools/raw/master/bpi-tools | sudo -
### Installation firmware avec emissary
Dans notre exemple nous partons d'une image openwrt avec emissary nommé: ```openwrt-22.03.2-emissary-v2023.08.02-bec8917-bcm27xx-bcm2711-rpi-4-squashfs-factory.img```
Dans cet exemple, nous partirons de l'image OpenWrt avec Emissary suivante : ```openwrt-22.03.2-emissary-v2023.08.02-bec8917-bcm27xx-bcm2711-rpi-4-squashfs-factory.img```
1. télécharger l'image depuis la [forge cadoles](https://forge.cadoles.com/arcad/emissary-firmware/releases)
Une fois téléchargé vous avez un .gz.</br>
2. extraire : ```gunzip openwrt-**-emissary-***-****-**-**-rpi-4-squashfs-factory.img.gz```
3. Ce placer dans le dossier contenant le fichier .img
4. Brancher la SDcard à votre machine. Pour valider/vérifier son appelation vous pouvez utiliser ```dmesg``` et observer les dernières lignes. (en générale /dev/sda)
5. Valider le chemin d'accès à la SDcard ( /dev/sd...)
6. Lancer la copie sur SDcard avec bpi-copy.
1. Téléchargement de l'image : Téléchargez l'image depuis la [forge cadoles](https://forge.cadoles.com/arcad/emissary-firmware/releases)
Après le téléchargement, vous obtiendrez un fichier au format .gz.</br>
2. Extraction : Exécutez la commande suivante pour extraire l'image (remplacez les ```**``` par les détails spécifiques du fichier) : ```gunzip openwrt-**-emissary-***-****-**-**-rpi-4-squashfs-factory.img.gz```
3. Déplacement dans le dossier : Placez-vous dans le dossier contenant le fichier .img.
4. Connexion de la carte SD : Branchez la carte SD sur votre machine. Pour vérifier l'identification de la carte, vous pouvez utiliser la commande ```dmesg``` et examiner les dernières lignes (généralement /dev/sda).
5. Vérification du chemin d'accès : Confirmez le chemin d'accès à la carte SD (/dev/sd...).
6. Copie sur la carte SD : Lancez la copie sur la carte SD en utilisant la commande bpi-copy (remplacez le nom de l'image et le chemin d'accès à la carte SD) :
```Shell
sudo bpi-copy openwrt-22.03.2-emissary-v2023.08.02-bec8917-bcm27xx-bcm2711-rpi-4-squashfs-factory.img /dev/sda
```
vous aurez un résultat ressemblant à :
Le résultat ressemblera à ceci :
```Shell
==============================================================
@ -78,37 +78,44 @@ RUNTIME 0:6
OK!! You can remove the BOOTDISK /dev/sda now!!
```
Une fois finie, retirer la carte SD, vous pouvez dès à présent la placer dans votre boitier de destination.
Une fois la copie terminée, retirez la carte SD. Vous pouvez maintenant l'insérer dans le boîtier de destination.
Une fois la carte flashé, vérifier que le switch à tout ces jumpers vers le haut, (sélection du boot), insérer la carte SD, puis brancher la borne.
Après avoir flashé la carte, assurez-vous que les commutateurs sont correctement positionnés (sélection du boot), insérez la carte SD et branchez la borne.
Vous pourrez vous brancher sur un port LAN du boitier qui délivrera du dhcp afin d'utiliser ssh pour y accéder.
Connectez-vous à un port LAN du boîtier qui distribuera une adresse IP via DHCP. Vous pourrez ensuite utiliser SSH pour y accéder.
### OS pour banana-bpi fournit par bpi
Installation d'openwrt fait pour bpi-r3, pour cela flasher une carte SD avec le fichier ```bananapi_bpi-r3-sdcard.img.gz``` fournit par openwrt [sur leur site page download](https://downloads.openwrt.org/snapshots/targets/mediatek/filogic/). Sinon aller dans les téléchargement et ce rendre à l'emplacement suivant :
Pour installer OpenWrt sur le BPI-R3, vous devez d'abord télécharger l'image ```bananapi_bpi-r3-sdcard.img.gz``` fourni par OpenWrt. Vous pouvez le télécharger depuis leur [page de téléchargement](https://downloads.openwrt.org/snapshots/targets/mediatek/filogic/). Si vous ne trouvez pas le fichier directement, suivez ces indications :
1. Accédez à la page de téléchargement OpenWrt (cf image suivante).
2. Recherchez le dossier correspondant au modèle de votre matériel, dans ce cas bananapi_bpi-r3.
3. Téléchargez le fichier bananapi_bpi-r3-sdcard.img.gz.
![img](./../img/bpi-r3-download.png)
### Flasher la carte avec le firware Openwrt de bpi
Après avoir téléchargé le fichier, vous pouvez continuer avec les étapes d'installation.
1. télécharger l'image depuis le liens précédent. Une fois téléchargé vous avez un .gz.</br>
2. extraire : ```gunzip bananapi_****.img.gz```
3. Ce placer dans le dossier contenant le fichier .img
4. Brancher la SDcard à votre machine. Pour valider/vérifier son appelation vous pouvez utiliser dmesg et observer les dernières lignes. (en générale sda)
5. Valider le chemin d'accès à la SDcard (souvent /dev/sd...)
6. Lancer la copie sur SDcard avec bpi-copy.
#### Flash du Firmware OpenWrt pour BPI
Suivez les étapes ci-dessous pour flasher la carte avec le firmware OpenWrt pour BPI :
1. Téléchargement de l'image : Si vous avez suivi les instructions précédentes, vous devriez avoir l'image de l'OS.
2. Extraction de l'image : Exécutez la commande suivante pour extraire l'image (remplacez les **** par les détails spécifiques du fichier) : ```gunzip bananapi_****.img.gz```
3. Placement de l'image : Placez-vous dans le dossier contenant le fichier .img.
4. Branchement de la carte SD : Branchez la carte SD sur votre machine. Pour vérifier son identification, utilisez ```dmesg``` et observez les dernières lignes (généralement sda).
5. Copie sur la carte SD : Lancez la copie sur la carte SD en utilisant la commande bpi-copy (remplacez les détails de l'image et le chemin d'accès à la carte SD) :
```Shell
sudo bpi-copy bananapi_bpi-r3-sdcard.img /dev/sda
```
Une fois la carte flashé, vérifier que le switch à tout ces jumpers vers le haut, (sélection du boot), insérer la carte SD, puis brancher la borne.
Une fois la carte flashée, assurez-vous que le switch a tous ses jumpers orientés vers le haut (sélection du boot). Insérez ensuite la carte SD et branchez la borne.
Votre carte réseau doit être paramétré ainsi :
Assurez-vous que votre carte réseau est configurée comme suit :
- dans le réseau 192.168.1.0/24
- sur la passerelle 192.168.1.1
- Réseau : 192.168.1.0/24
- Passerelle : 192.168.1.1
Brancher votre câble RJ45 sur le port VLAN1, et connectez vous en ssh.(temps de boot moins de 30 secondes)
@ -116,18 +123,18 @@ Brancher votre câble RJ45 sur le port VLAN1, et connectez vous en ssh.(temps de
ssh root@192.168.1.1
```
pour la première connexion il n'y a pas de mot de passe.
Pour la première connexion, aucun mot de passe n'est requis.
## FAQ
### Comment sélectionner le boot système ?
### Sélection du Système de Boot
Il y a un switch de quatre jumper à manipuler pour sélectionner le choix de boot. Par défaut ils sont tous en haut, définissant le boot sur la carte microSD.
Pour choisir le système de boot, il suffit de manipuler un switch composé de quatre jumpers. Par défaut, ils sont tous en position haute, ce qui configure le démarrage à partir de la carte microSD.
![switch](./../img/bpi-r3-switch.png)
![schéma du switch](./../img/bpi-r3-switch.png)
### Quels sont les noms des périphériques réseau ?
### Noms des Périphériques Réseau
Par défaut les périphériques réseau sont ainsi disposé et nommé:
Par défaut, les périphériques réseau sont disposés et nommés comme suit :
![Lan](./../img/bpi-r3-lan-pic.jpg)

View File

@ -65,7 +65,7 @@ Dans ce tutoriel, nous allons voir comment créer une nouvelle cible de construc
3. Préparation.
Lancer la commande suivante pour télécharger (ou mettre à jours) les bon tar.gz nécessaire à la construction du firmware. Si cette commande n'a pas été lancée au moins une fois, vous ne pourrez pas construire le/les firmware.
Lancer la commande suivante pour télécharger (ou mettre à jours) les fichiers tar.gz nécessaire à la construction du firmware. Si cette commande n'a pas été exécutée au moins une fois, vous ne serez pas en mesure de construire le ou les firmwares nécessaires.
```shell
make download-emissary-release
@ -77,7 +77,7 @@ Dans ce tutoriel, nous allons voir comment créer une nouvelle cible de construc
make bpi-r3
```
Les fichiers du firmware seront générés dans le répertoire `bin/snapshot/mediatek/filogic/bananapi_bpi-r3/`
Les fichiers du firmware seront générés dans le répertoire `depot/bin/snapshot/mediatek/filogic/bananapi_bpi-r3/`
> 🛈 **Comment trouver les valeurs des variables `OPENWRT_TARGET` et `OPENWRT_PROFILE` ?**
>