update Readme and indexes

mchobby · May 22, 2023 · 3533765 · 3533765
1 parent 167e775
commit 3533765
Show file tree

Hide file tree

Showing 378 changed files with 6,129 additions and 646 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +0,0 @@
-[submodule "webrepl"]
-	path = webrepl
-	url = https://github.com/micropython/webrepl

diff --git a/COLORS/package.json b/COLORS/package.json
@@ -0,0 +1,7 @@
+{
+  "urls": [
+    ["colors.py", "github:mchobby/esp8266-upy/COLORS/lib/colors.py"],
+    ["colortls.py", "github:mchobby/esp8266-upy/COLORS/lib/colortls.py"]
+  ],
+  "version": "1.0"
+}
diff --git a/COLORS/readme.md b/COLORS/readme.md
@@ -6,6 +6,24 @@ Cette bibliothèque centralise quelques outils (fonction, listes, etc) relatifs
 
 N'hésitez pas à explorer les bibliothèques et ressources pour plus d'informations.
 
+# Bibliothèque
+
+Cette bibliothèque doit être copiée sur la carte MicroPython avant d'utiliser les exemples.
+
+Sur une plateforme connectée:
+
+```
+>>> import mip
+>>> mip.install("github:mchobby/esp8266-upy/COLORS")
+```
+
+Ou via l'utilitaire mpremote :
+
+```
+mpremote mip install github:mchobby/esp8266-upy/COLORS
+```
+
+
 # Sources d'inspiration
 
 ## Color Picker de W3School

diff --git a/COLORS/readme_ENG.md b/COLORS/readme_ENG.md
@@ -6,6 +6,23 @@ This library groups tools (function, list, etc) reharding color manipulation rel
 
 Do not hesitate to browse the libraries and ressources for more information.
 
+# Library
+
+The library must be copied on the MicroPython board before using the examples.
+
+On a WiFi capable plateform:
+
+```
+>>> import mip
+>>> mip.install("github:mchobby/esp8266-upy/COLORS")
+```
+
+Or via the mpremote utility :
+
+```
+mpremote mip install github:mchobby/esp8266-upy/COLORS
+```
+
 # Source of inspiration
 
 ## W3School Color Picker

diff --git a/FILEFORMAT/package.json b/FILEFORMAT/package.json
@@ -0,0 +1,8 @@
+{
+  "urls": [
+    ["img.py", "github:mchobby/esp8266-upy/FILEFORMAT/imglib/img.py"],
+		["bmp.py", "github:mchobby/esp8266-upy/FILEFORMAT/imglib/bmp.py"],
+		["bpm.py", "github:mchobby/esp8266-upy/FILEFORMAT/imglib/bpm.py"]
+  ],
+  "version": "1.0"
+}
diff --git a/FILEFORMAT/readme.md b/FILEFORMAT/readme.md
@@ -9,6 +9,24 @@ Cela évite de charger le fichier en mémorie et de saturer celle-ci (un avantag
 
 En contrepartie, cela impique aussi plus d'accès fichiers et plus de transfert octet par octet (et donc un code moins performant).
 
+# Bibliothèque
+
+Cette bibliothèque doit être copiée sur la carte MicroPython avant d'utiliser les exemples.
+
+Sur une plateforme connectée:
+
+```
+>>> import mip
+>>> mip.install("github:mchobby/esp8266-upy/FILEFORMAT")
+```
+
+Ou via l'utilitaire mpremote :
+
+```
+mpremote mip install github:mchobby/esp8266-upy/FILEFORMAT
+```
+
+
 # IMAGES (format supportés)
 
 ## Le format bmp

diff --git a/FILEFORMAT/readme_ENG.md b/FILEFORMAT/readme_ENG.md
@@ -11,6 +11,23 @@ This is avoids to load the file into memory and overload it (an important featur
 
 In counterpart, this also imply for file access and more byto to byte transfer (so it is also slower).
 
+# Library
+
+The library must be copied on the MicroPython board before using the examples.
+
+On a WiFi capable plateform:
+
+```
+>>> import mip
+>>> mip.install("github:mchobby/esp8266-upy/FILEFORMAT")
+```
+
+Or via the mpremote utility :
+
+```
+mpremote mip install github:mchobby/esp8266-upy/FILEFORMAT
+```
+
 # IMAGES (supported format)
 
 ## BMP format
@@ -53,7 +70,7 @@ Ressources:
 * [bmp_file_format @ www.ece.ualberta.ca](http://www.ece.ualberta.ca/~elliott/ee552/studentAppNotes/2003_w/misc/bmp_file_format/bmp_file_format.htm) from Nathan Liesch
 
 
-## Le format PBM (Portable Bit Map)
+## The PBM format (Portable Bit Map)
 The PBM is used to encore 2 color images (1 bit color, white/black). It does exists a text based format version (verbose) and a binary format (more compact).
 
 Create a PBM file is quite easy with tool like Gimp. Load the image into Gimp then select the `File | Exporter as...` menu entry. Name your exported file with `.pbm` extension. __No need for color filtering and treatment, Gimp does applu a filter that perfectly degrade the colors to white/black image__.

diff --git a/NCD/ncd_conn.png → NCD/docs/_static/ncd_conn.png b/NCD/ncd_conn.png → NCD/docs/_static/ncd_conn.png
diff --git a/NCD/ncd_example.jpg → NCD/docs/_static/ncd_example.jpg b/NCD/ncd_example.jpg → NCD/docs/_static/ncd_example.jpg
diff --git a/NCD/ncd_feather(hires).png → NCD/docs/_static/ncd_feather(hires).png b/NCD/ncd_feather(hires).png → NCD/docs/_static/ncd_feather(hires).png
diff --git a/NCD/ncd_feather.png → NCD/docs/_static/ncd_feather.png b/NCD/ncd_feather.png → NCD/docs/_static/ncd_feather.png
diff --git a/NCD/ncd_samples.jpg → NCD/docs/_static/ncd_samples.jpg b/NCD/ncd_samples.jpg → NCD/docs/_static/ncd_samples.jpg
diff --git a/NCD/ncd_wemos(hires).png → NCD/docs/_static/ncd_wemos(hires).png b/NCD/ncd_wemos(hires).png → NCD/docs/_static/ncd_wemos(hires).png
diff --git a/NCD/ncd_wemos.png → NCD/docs/_static/ncd_wemos.png b/NCD/ncd_wemos.png → NCD/docs/_static/ncd_wemos.png
diff --git a/NCD/uext-to-ncd(hires).png → NCD/docs/_static/uext-to-ncd(hires).png b/NCD/uext-to-ncd(hires).png → NCD/docs/_static/uext-to-ncd(hires).png
diff --git a/NCD/uext-to-ncd.png → NCD/docs/_static/uext-to-ncd.png b/NCD/uext-to-ncd.png → NCD/docs/_static/uext-to-ncd.png
diff --git a/NCD/readme.md b/NCD/readme.md
@@ -4,16 +4,16 @@
 
 ([National Control Device](https://store.ncd.io)) a créé de nombreuses cartes capteurs I2C (nommée "_I2C Mini Board_" ou mini carte I2C) exploitant un connecteur standardisé à 4 broches et utilisant une __alimentation 5V__ et __logique 5V__.
 
-![Quelques mini cartes I2C de NCD](ncd_samples.jpg)
+![Quelques mini cartes I2C de NCD](docs/_static/ncd_samples.jpg)
 
 Utiliser une interface standardisée sur une __grande variété de carte__ (comme Arduino, Raspberry, Feather, WiPy, LoPy, etc) et carte capteur est absolument génial! Ce facilite la prototypage et le développement de solutions personnalisées sans la difficulté d'avoir à disposer de connaissances en électronique ou en soudure (NCD maintien également un GitHub communautaire avec du code pour Arduino, C, Python, ...).
 
-![NCD usage example](ncd_example.jpg)
+![NCD usage example](docs/_static/ncd_example.jpg)
 
 # Connecteur NCD
 Pour connecter une mini carte I2C de NCD, vous aurez besoin d'un connecteur NCD (connecteur de sortie I2C) et fils de raccordement.
 
-![Connecteur NCD](ncd_conn.png)
+![Connecteur NCD](docs/_static/ncd_conn.png)
 
 NCD dispose déjà de nombreuses cartes adaptateur [disponibles ici](https://store.ncd.io/shop/?fwp_product_type=adapters) mais nous pouvons également créer nos propres branchement vers d'autres cartes de développement (comme suggéré ci-dessous).
 
@@ -25,7 +25,7 @@ NCD propose un adaptateur pour Feather ([voir ici](https://store.ncd.io/product/
 
 La broche 5V du Feather n'offre une alimentation 5V uniquement lorsque la plateforme est branchées sur une source USB. Un [régulateur DC/DC step-up/down](https://shop.mchobby.be/fr/regulateurs/463-regul-5v-500ma-step-updown-s7v7f5-3232100004634-pololu.html) peut également être utilisé pour fournir la tension 5V sur le connecteur NCD (depuis la broche BAT du Feather).
 
-![Brancher une carte NCD sur un Feather ESP8266](ncd_feather.png)
+![Brancher une carte NCD sur un Feather ESP8266](docs/_static/ncd_feather.png)
 
 ## Créer le bus I2C
 
@@ -39,7 +39,7 @@ i2c = I2C( sda=Pin(4), scl=Pin(5) )
 # Connecteur NCD sur un Wemos D1
 Le Wemos D1 est l'une des plateformes ESP8266 les plus populaires. Sauf erreur, il n'y a pas encode de carte adaptateur pour le Wemos D1.
 
-![Brancher une carte NCD sur un Wemos D1](ncd_wemos.png)
+![Brancher une carte NCD sur un Wemos D1](docs/_static/ncd_wemos.png)
 
 ## Créer le bus I2C
 
@@ -60,7 +60,7 @@ De nombreux produits Olimex (incluant l' ESP8266-EVB) expose le connecteur stand
 
 Ce connecteur UEXT en logique 3.3V doit être adapté vers un niveau logique 5V à l'aide d'un _level shifter_. Le connecteur NCD doit également être alimenté avec une source de tension 5V externe.
 
-![Connecteur UEXT vers connecteur NCD](uext-to-ncd.png)
+![Connecteur UEXT vers connecteur NCD](docs/_static/uext-to-ncd.png)
 
 ## Créer le bus I2C
 

diff --git a/NCD/readme_eng.md b/NCD/readme_eng.md
@@ -4,17 +4,17 @@
 
 ([National Control Device](https://store.ncd.io)) created a lot of I2C sensor boards (namely "I2C Mini Board") featuring a standardized 4 pins connectors and using 5V logic for signal an Power.
 
-![Some NCD I2C mini board](ncd_samples.jpg)
+![Some NCD I2C mini board](docs/_static/ncd_samples.jpg)
 
 Using such standarized interface on a __wide variety of board__ (Arduino, Raspberry, Feather, WiPy, LoPy, etc) and sensor boards are really great! It helps prototyping and development of custom solution without the hardness of being skilled in electronics and soldering (NCD also maintain a community GitHub with code for Arduino, C, Python, ...).
 
-![NCD usage example](ncd_example.jpg)
+![NCD usage example](docs/_static/ncd_example.jpg)
 
 # NCD connector
 
 So, to connect NCD I2C mini boards, you will needs an NCD Connector (I2C output connector) and the wires.
 
-![NCD connector](ncd_conn.png)
+![NCD connector](docs/_static/ncd_conn.png)
 
 NCD already have of lot of adapter boards [available here](https://store.ncd.io/shop/?fwp_product_type=adapters) but we can also design wiring for other development plateforms (as suggested here under).
 
@@ -26,7 +26,7 @@ NCD already propose a Feather adapter board ([see here](https://store.ncd.io/pro
 
 5V pin only supplies 5V output when the plateform is plugged on USB source. A [step-up/down DC/DC regulator](https://shop.mchobby.be/fr/regulateurs/463-regul-5v-500ma-step-updown-s7v7f5-3232100004634-pololu.html) can also be used to supply the NCD 5V from the feather BAT pin.
 
-![Wiring an NCD board on ESP8266](ncd_feather.png)
+![Wiring an NCD board on ESP8266](docs/_static/ncd_feather.png)
 
 ## Create the I2C bus
 
@@ -41,7 +41,7 @@ i2c = I2C( sda=Pin(4), scl=Pin(5) )
 
 The Wemos D1 is one of the most popular ESP8266 plateform. As far we know, NCD doesn't have adapter board for that plateform.
 
-![Wiring an NCD board on Wemos D1](ncd_wemos.png)
+![Wiring an NCD board on Wemos D1](docs/_static/ncd_wemos.png)
 
 ## Create the I2C bus
 
@@ -62,7 +62,7 @@ The lot of Olimex's products (including the ESP8266-EVB) exposes the standard UE
 
 This 3.3V logic level connector must be adapted with a level shifter to 5V logic level. The NCD must also been feed with an external 5V power source.
 
-![UEXT Connector to NCD connector](uext-to-ncd.png)
+![UEXT Connector to NCD connector](docs/_static/uext-to-ncd.png)
 
 ## Create the I2C bus
 

diff --git a/SMALL-FONT/package.json b/SMALL-FONT/package.json
@@ -0,0 +1,6 @@
+{
+  "urls": [
+    ["sfont.py", "github:mchobby/esp8266-upy/SMALL-FONT/lib/sfont.py"]
+  ],
+  "version": "0.0.1"
+}
diff --git a/SMALL-FONT/readme.md b/SMALL-FONT/readme.md
@@ -14,6 +14,23 @@ Il y a deux options pour utiliser une autre font:
 * __SMALL-FONT__ : __le présent projet__ permet d'écrire du texte en utilisant une font nettement plus compacte (projet issu du [portage du pilote st7687s](https://github.com/mchobby/esp8266-upy/tree/master/st7687s) ).
 * __FreeType-Generator__ : [un projet alternatif](https://github.com/mchobby/freetype-generator) permettant de créer un fichier binaire pour charger une font sous MicroPython. Fichier exploité avec la classe FontDrawer pour dessiner le texte dans un FrameBuffer.
 
+# Bibliothèque
+
+Cette bibliothèque doit être copiée sur la carte MicroPython avant d'utiliser les exemples.
+
+Sur une plateforme connectée:
+
+```
+>>> import mip
+>>> mip.install("github:mchobby/esp8266-upy/SMALL-FONT")
+```
+
+Ou via l'utilitaire mpremote :
+
+```
+mpremote mip install github:mchobby/esp8266-upy/SMALL-FONT
+```
+
 # Utiliser
 
 Le projet SMALL-FONT est principalement constitué de la classe `FontDrawer` dans le fichier [lib/sfont.py](lib/sfont.py) .

diff --git a/SMALL-FONT/readme_ENG.md b/SMALL-FONT/readme_ENG.md
@@ -14,6 +14,24 @@ It exists two other options for Font drawing:
 * __SMALL-FONT__ : __this project__ allows to write text with less thicker font (coming from [st7687s display driver](https://github.com/mchobby/esp8266-upy/tree/master/st7687s) ).
 * __FreeType-Generator__ : [an alternative project](https://github.com/mchobby/freetype-generator) creating a binary file for Fonts under MicroPython. File used with the FontDrawer class to draw text into the FrameBuffer.
 
+
+# Library
+
+The library must be copied on the MicroPython board before using the examples.
+
+On a WiFi capable plateform:
+
+```
+>>> import mip
+>>> mip.install("github:mchobby/esp8266-upy/SMALL-FONT")
+```
+
+Or via the mpremote utility :
+
+```
+mpremote mip install github:mchobby/esp8266-upy/SMALL-FONT
+```
+
 # Using
 
 The SMALL-FONT project is mainly made of the `FontDrawer` class stored in [lib/sfont.py](lib/sfont.py) (_Small Font_).

diff --git a/ad9833/package.json b/ad9833/package.json
@@ -0,0 +1,6 @@
+{
+  "urls": [
+		["ad9833.py", "github:mchobby/esp8266-upy/ad9833/lib/ad9833.py"]
+  ],
+  "version": "1.0"
+}
diff --git a/ad9833/readme.md b/ad9833/readme.md
@@ -14,6 +14,23 @@ L' AD9833 genere un signal avec une tension de 0.6 Vpp (pic à pic).
 
 Pour plus d'information, n'hésitez pas à consulter cette [fiche produit](http://shop.mchobby.be/product.php?id_product=1689) .
 
+# Bibliothèque
+
+ Cette bibliothèque doit être copiée sur la carte MicroPython avant d'utiliser les exemples.
+
+ Sur une plateforme connectée:
+
+ ```
+ >>> import mip
+ >>> mip.install("github:mchobby/esp8266-upy/ad9833")
+ ```
+
+ Ou via l'utilitaire mpremote :
+
+ ```
+ mpremote mip install github:mchobby/esp8266-upy/ad9833
+ ```
+
 # Brancher
 
 ![Raccorder un AD9833 sur une Pyboard](docs/_static/ad9833-to-pyboard.jpg)

diff --git a/ad9833/readme_ENG.md b/ad9833/readme_ENG.md
@@ -14,11 +14,29 @@ The AD9833 generates a signal with a voltage of 0.6 Vpp (peak to peak).
 
 For more information, please check this [product sheet](http://shop.mchobby.be/product.php?id_product=1689) .
 
+# Library
+
+The library must be copied on the MicroPython board before using the examples.
+
+On a WiFi capable plateform:
+
+```
+>>> import mip
+>>> mip.install("github:mchobby/esp8266-upy/ad9833")
+```
+
+Or via the mpremote utility :
+
+```
+mpremote mip install github:mchobby/esp8266-upy/ad9833
+```
+
+
 # Wiring
 
 ![Wire the AD9833 to Pyboard](docs/_static/ad9833-to-pyboard.jpg)
 
-__ATTENTION__ : bad quality connections (breadboard, bad quality wire) will drive you crazy! 
+__ATTENTION__ : bad quality connections (breadboard, bad quality wire) will drive you crazy!
 
 # Test it
 

diff --git a/adfmotors/lib/pca9685.py b/adfmotors/lib/pca9685.py
diff --git a/adfmotors/package.json b/adfmotors/package.json
@@ -0,0 +1,9 @@
+{
+  "urls": [
+    ["pca9685.py", "github:mchobby/esp8266-upy/pca9685/lib/pca9685.py"],
+		["motorbase.py", "github:mchobby/esp8266-upy/adfmotors/lib/motorbase.py"],
+		["motorshield.py", "github:mchobby/esp8266-upy/adfmotors/lib/motorshield.py"],
+		["motorwing.py", "github:mchobby/esp8266-upy/adfmotors/lib/motorwing.py"]
+  ],
+  "version": "1.0"
+}
diff --git a/adfmotors/readme.md b/adfmotors/readme.md
@@ -5,6 +5,23 @@ Cette bibliothèque prend en charge le [Motor Shield d'Adafruit](https://shop.mc
 
 ![MotorShield d'Adafruit](docs/_static/motorshield.jpg)
 
+# Bibliothèque
+
+ Cette bibliothèque doit être copiée sur la carte MicroPython avant d'utiliser les exemples.
+
+ Sur une plateforme connectée:
+
+ ```
+ >>> import mip
+ >>> mip.install("github:mchobby/esp8266-upy/adfmotors")
+ ```
+
+ Ou via l'utilitaire mpremote :
+
+ ```
+ mpremote mip install github:mchobby/esp8266-upy/adfmotors
+ ```
+
 # Raccordement
 La carte Motor Shield (ou Motor Wing) peut être utilisée avec plusieurs cartes microcontrôleur.