30 894
modifications
Modifications
Sauter à la navigation
Sauter à la recherche
Ligne 1 :
Ligne 1 : − {{traduction}}+ + − = Préambule =+ − Ligne 8 :
Ligne 8 : − Il est aussi beaucoup plus complet que [[FEATHER-CHARGER-FICHIER-MICROPYTHON|Ampy]] (Adafruit), il faudra donc investir un peu plus de temps pour le maîtriser. + Ligne 16 :
Ligne 16 : − + Ligne 22 :
Ligne 22 : − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + − − + − + Ligne 44 :
Ligne 77 : − + − + + + Ligne 188 :
Ligne 223 : − + Ligne 270 :
Ligne 305 : − − {{traduction}} Ligne 282 :
Ligne 315 : + + + + Ligne 294 :
Ligne 331 : − + Ligne 315 :
Ligne 352 : − + − Display a line of text.+ − + − If the file is on a pyboard, it copies the file to host, invokes an+ − editor and if any changes were made to the file, it copies it back to − the pyboard. − The editor which is used defaults to vi, but can be overridem using+ − either the --editor command line option when rshell.py is invoked, or by+ − using the RSHELL\_EDITOR, VISUAL or EDITOR environment variables (they+ − are tried in the order listed).+ + + + − Prints the size of the file, in bytes. This function is primarily+ − testing. − + − Prints the type of file (dir or file). This function is primarily for+ − testing. − + − List available commands with no arguments, or detailed help when a+ − command is provided. − Utilisation:+ − ls [-a] [-l] FILE...+ − List directory contents.+ + − positional arguments:+ − FILE Files or directories to list+ − + − optional arguments:+ − -h, --help show this help message and exit − -a, --all do not ignore hidden files − -l, --long use a long listing format − + − Creates one or more directories.+ − + − Enters into the regular REPL with the MicroPython board. Use Control-X+ − to exit REPL mode and return the shell. It may take a second or two − before the REPL exits. − If you provide a board-name then rshell will connect to that board,+ − otherwise it will connect to the default board (first connected board). − If you provide a tilde followed by a space (~ ) then anything after the+ − tilde will be entered as if you typed it on the command line. − If you want the repl to exit, end the line with the ~ character.+ − For example, you could use:+ + + − and it will boot the pyboard into DFU.+ − Removes files or directories (directories must be empty).+ − − + − positional arguments:+ − FILE File to remove+ − optional arguments:+ − -h, --help show this help message and exit+ − -r, --recursive remove directories and their contents recursively+ − -f, --force ignore nonexistant files and arguments+ − The shell command can also be abbreviated using the exclamation point.+ + − shell some-command+ − !some-command − This will invoke a command, and return back to rshell. Example:+ + − will flash the pyboard.+
MicroPython-Hack-RShell (voir la source)
Version du 21 janvier 2021 à 11:58
, 21 janvier 2021 à 11:58→Qu'est ce que RSHell?
= Préambule =
[[Fichier:RShell-logo.jpg|480x]]
Voici une traduction libre de la documentation de l'outil RShell écrit par Dave Hylands.
Voici une traduction libre de la documentation de l'outil RShell écrit par Daniel Hylands.
C'est un outil très intéressant pour réaliser des développements MicroPython, RShell fonctionne avec de nombreuses cartes MicroPython dont PyBoard, ESP8266, Teensy et toutes carte MicroPython ayant une invite REPL sur un port série.
C'est un outil très intéressant pour réaliser des développements MicroPython, RShell fonctionne avec de nombreuses cartes MicroPython dont PyBoard, ESP8266, Teensy et toutes carte MicroPython ayant une invite REPL sur un port série.
C'est tellement génial que cela fonctionne même via une [[MicroPython-bluetooth|connexion Bluetooth série]].
C'est tellement génial que cela fonctionne même via une [[MicroPython-bluetooth|connexion Bluetooth série]].
RShell est aussi beaucoup plus complet que [[FEATHER-CHARGER-FICHIER-MICROPYTHON|Ampy]] (Adafruit), il faudra donc investir un peu plus de temps pour le maîtriser. Ses fonctionnalités avancées sauront se faire apprécier.
Vous trouverez [https://github.com/dhylands/rshell RShell ici sur GitHub]
Vous trouverez [https://github.com/dhylands/rshell RShell ici sur GitHub]
* Dec 13, 2016 - Traduction jusqu'à révision 480945c du Apr 30, 2016
* Dec 13, 2016 - Traduction jusqu'à révision 480945c du Apr 30, 2016
= RShell sur ESP8266 =
== RShell sur ESP8266 ==
{{ambox-stop|text=Il est impératif de réduire la taille du buffer à 128 octets sur un ESP8266 sinon vous risquez d'écraser le système de fichier votre ESP8266... auquel cas il faudra reflasher votre carte}}
{{ambox-stop|text=Il est impératif de réduire la taille du buffer à 128 octets sur un ESP8266 sinon vous risquez d'écraser le système de fichier votre ESP8266... auquel cas il faudra reflasher votre carte}}
<nowiki>rshell --port /dev/ttyUSB0 --baud 115200 --buffer-size 128 --editor nano</nowiki>
<nowiki>rshell --port /dev/ttyUSB0 --baud 115200 --buffer-size 128 --editor nano</nowiki>
Nous avons également un petit script shell [https://github.com/mchobby/esp8266-upy/blob/master/rshell-esp8266.sh rsheel-esp8266.sh] pour faciliter faciliter le démarrage de rshell pour un esp8266.
Nous avons également un petit script shell [https://github.com/mchobby/esp8266-upy/blob/master/rshell-esp8266.sh rsheel-esp8266.sh] pour faciliter faciliter le démarrage de rshell pour un esp8266.
== RShell sur ESP32 (M5Stack) ==
L'outil RShell ne détecte pas automatiquement le port série associé au M5Stack. Il sera donc nécessaire de le stipuler au lancement de RShell.
<nowiki>rshell --port /dev/ttyUSB0 --editor nano</nowiki>
Sur un système Linux, il est facile d'identifier le port série dans les messages envoyés par le noyaux Linux lors de la connexion de l'ESP32 sur un port USB.
Brancher l'ESP32 / M5-Core puis exécuter la commande {{fname|dmesg}} dans un terminal pour collecter les messages de débogage.
<nowiki>[441990.881362] usb 2-3.2: new full-speed USB device number 16 using xhci_hcd
[441990.983365] usb 2-3.2: New USB device found, idVendor=10c4, idProduct=ea60
[441990.983368] usb 2-3.2: New USB device strings: Mfr=1, Product=2, SerialNumber=3
[441990.983370] usb 2-3.2: Product: CP2104 USB to UART Bridge Controller
[441990.983371] usb 2-3.2: Manufacturer: Silicon Labs
[441990.983373] usb 2-3.2: SerialNumber: 01DB6B96
[441990.984594] cp210x 2-3.2:1.0: cp210x converter detected
[441990.985755] usb 2-3.2: cp210x converter now attached to ttyUSB0</nowiki>
il s'agit ici du port '''ttyUSB0''' et donc du périphérique '''/dev/ttyUSB0'''
== RShell sur WiPy/WiPy2 ==
Nous recommandons vivement de modifier le mot de passe et utilisateur par défaut de votre WiPy/WiPy 2.
Voici des exemples concernant les plateformes WiPy et WiPy2.
Exemple avec WiPy et WiPy 2:
<nowiki>rshell --port 192.168.2.200 --user micro --password python --editor nano</nowiki>
== RShell sur Pico ==
Les tests préliminaires concernant le {{pl|2025|Raspberry-Pi Pico}} démontre qu'il est préférable de réduire la taille du Buffer à 32 octets.
<nowiki>rshell --port /dev/ttyACM0 --buffer-size 32 --editor nano</nowiki>
= RShell: Shell distant pour MicroPython =
= RShell: Shell distant pour MicroPython =
== Qu'est ce que RSHell? ==
== Qu'est ce que RSHell? ==
Le shell distant (en ''remote'') pour MicroPython
Le shell distant (en ''remote'') pour MicroPython. Ce dernier fonctionne comme une ligne de commande depuis votre ordinateur mais permet d'interagir avec un microcontroleur MicroPython par l'intermédiaire d'une communicaion série.
RShell est un simple shell qui est exécuté sur un hôte et utilise le more raw-REPL de Micropython pour envoyer des commandes vers une carte micro python.
RShell utilise le mode raw-REPL de Micropython pour envoyer des commandes vers une carte micro python et ainsi modifier son système de fichier.
Cela permet:
Cela permet:
Le grand bénéfice de cette approche est de permettre le transfert de fichier et REPL par l'intermédiaire d'une simple connexion série (filaire, USB et '''Port-Série via Bluetooth''' [[MicroPython-bluetooth|comme décrit ici]]).
Le grand bénéfice de cette approche est de permettre le transfert de fichier et REPL par l'intermédiaire d'une simple connexion série (filaire, USB et '''Port-Série via Bluetooth''' [[MicroPython-bluetooth|comme décrit ici]]).
== PC ou /flash ou /sdcard ==
== PC ou /flash ou /sdcard ou /pyboard ==
{{ambox|text=RShell utilise une notation particulière pour les échanges de fichiers.}}
{{ambox|text=RShell utilise une notation particulière pour les échanges de fichiers.}}
Lorsque vous utilisez des commandes RShell, les répertoires {{fname|/flash}} et {{fname|/sdcard}} (si vous utilisez une carte SD) sont considérés comme étant sur la carte MicroPython.
Lorsque vous utilisez des commandes RShell, les répertoires {{fname|/flash}} et {{fname|/sdcard}} (si vous utilisez une carte SD) sont considérés comme étant sur la carte MicroPython.
Dans certains cas, comme pour l'ESP8266, c'est le répertoire {{fname|/pyboard}} qu'il faut utiliser à la place de {{fname|/flash}}. En cas de doute, l'utilisation de la commande {{fname|boards}} permet de lister les cartes connectées (et répertoires distants associés).
Tous les autres répertoires sont réputés être sur l'hôte (votre Ordinateur).
Tous les autres répertoires sont réputés être sur l'hôte (votre Ordinateur).
Pour les débutants, nous recommandons l'usage de l'éditeur {{fname|nano}} plus abordable que 'vi'.</small>
Pour les débutants, nous recommandons l'usage de l'éditeur {{fname|nano}} plus abordable que 'vi'.</small>
=== Fichier de commandes RSheel ===
=== Fichier de commandes RShell ===
-f NOM_FICHIER, --file NOM_FICHIER
-f NOM_FICHIER, --file NOM_FICHIER
== Commandes ==
== Commandes ==
Voici une liste des commandes que vous pouvez utiliser dans RShell.
Voici une liste des commandes que vous pouvez utiliser dans RShell.
=== args ===
=== args ===
Liste/affiche toutes les cartes actuellement connectés sur RSHell, leurs nomst et point de connexion.
Liste/affiche toutes les cartes actuellement connectés sur RSHell, leurs nomst et point de connexion.
Voici un exemple de résultat (avec un carte Feather Huzzah ESP8266 sous MicroPython):
[[Fichier:MicroPython-Hack-RShell-boards.png]]
=== cat ===
=== cat ===
cd REPERTOIRE
cd REPERTOIRE
Chanqe le répertoire courant de RSheel. L'extension ~ est supportée et {{fname|cd -}} permet de revenir au répertoire précédent.
Chanqe le répertoire courant de RShell. L'extension ~ est supportée et {{fname|cd -}} permet de revenir au répertoire précédent.
=== connect ===
=== connect ===
=== echo ===
=== echo ===
echo TEXT...
echo TEXTE...
Affiche une ligne de texte.
=== edit ===
=== edit ===
edit filename
edit nom-du-fichier
Permet d'éditer un fichier dans l'éditeur configuré dans RShell.
Si le fichier est sur une carte MicroPython ALORS:
# Le fichier est copié sur l'hôte,
# L'éditeur est invoqué,
# Et si le fichier à été modifié
## le fichier modifié est renvoyé vers la carte MicroPython.
L'éditeur par défaut est '''vi''' mais peut être mais peut être modifié en utilisant l'option --editor en ligne de commande. Vous pouvez également modifier l'éditeur par défaut en utilisant l'une des variables d'environnement suivantes RSHELL_EDITOR, VISUAL ou EDITOR (ces variables sont testées dans l'ordre indiqué).
=== filesize ===
=== filesize ===
filesize FILE
filesize FILE
Affiche la taille du fichier (en bytes/octets). ''Cette commande est en cours d'évaluatation''.
=== filetype ===
=== filetype ===
filetype FILE
filetype FICHIER
Affiche le type de fichier: '''dir''' pour répertoire ou '''file''' pour fichier. ''Cette commande est en cours d'évaluation''.
=== help ===
=== help ===
help [COMMAND]
help [COMMANDE]
Affiche une liste des commandes disponible (sans argument), ou affiche une aide détaillée su un COMMANDE est spécifiée en paramètre.
=== ls ===
=== ls ===
ls [-a] [-l] FICHIER...
Affiche le contenu d'un répertoire.
Arguments positionnels:
* '''FICHIER''' : Fichiers ou répertoires à lister
Arguments optionnels:
* '''-h, --help''' : Affiche ce message d'aide puis rend la main.
* '''-a, --all''' : Affiche tous les fichiers (y compris les fichiers cachés)
* '''-l, --long''' : Utilise le format long de type "listing"
=== mkdir ===
=== mkdir ===
mkdir DIRECTORY...
mkdir REPERTOIRE...
Crée un ou plusieurs répertoires.
=== repl ===
=== repl ===
repl [board-name] [~ line][ ~]
repl [nom-de-la-carte] [~ ligne][ ~]
Entre en mode REPL standard avec la carte MicroPython.
Utilisez Control-X pour sortir du mode REPL et revenir au shell. La carte MicroPython peut avoir besoin d'une seconde ou deux pour sortie du mode REPL.
Si ''nom-de-la-carte'' est fournit en argument alors RShell essaye de se connecter sur cette carte. A défaut, RShell se connecte sur la la première carte connectée.
Si la ligne de commande contient un caractère tilde suivit d'un espace (~ ) alors tout ce qui se trouve après le tilde est envoyé vers REPL comme si vous l'aviez saisit au clavier dans la session REPL.
Si vous voulez sortir de REPL alors terminé votre ligne par le caractère tilde (~).
Par exemple, vous pouvez saissir:
rshell.py repl ~ pyb.bootloader()~
rshell.py repl ~ pyb.bootloader()~
Ce qui aura pour effet de démarrer la carte en mode DFU (''Device Firmware Update'').
=== rm ===
=== rm ===
rm [-r|--recursive][-f|--force] FICHIER...
rm [-r|--recursive][-f|--force] FILE...
Efface un fichier ou un répertoire du système de fichier (les répertoires doivents être vides).
Argument positionnel:
* '''FICHIER''' : Fichier ou répertoire à effacer
Arguments optionnels:
* '''-h, --help''' : Affiche le message d'aide (en anglais) et termine l'exécution
* '''-r, --recursive''' : Efface récursivement les répertoires et leurs contenus
* '''-f, --force''' : Ignore les fichier existant (et arguments inexistants)
=== shell ===
=== shell ===
shell commande-shell
!commande-shell
Ceci invoke une commande dans le shell de votre système d'exploitation puis rend la main à RShell.
La commande {{fname|shell}} peut être remplacée par son abréviation {{fname|!}}.
Exemple:
!make deploy
!make deploy
Dans l'exemple ci-dessus, l'utilitaire {{fname|make}} est appelé avec l'argument ''deploy'' dans le shell du système d'exploitation. Cela permet, en autre, de pouvoir flasher une carte PyBoard.