Merge pull request #3 from brainelectronics/bugfix/docs-and-usage-fixes

Docs and usage fixes

Author: brainelectronics

.github/workflows/test.yml

@@ -52,3 +52,11 @@ jobs:
       - name: Test built package
         run: |
           twine check dist/*
+      - name: Validate mip package file
+        run: |
+          upy-package \
+            --setup_file setup.py \
+            --package_changelog_file changelog.md \
+            --package_file package.json \
+            --validate \
+            --ignore-version

README.md

@@ -7,13 +7,13 @@
 [![codecov](https://codecov.io/github/brainelectronics/micropython-i2c-lcd/branch/main/graph/badge.svg)](https://app.codecov.io/github/brainelectronics/micropython-i2c-lcd)
 [![CI](https://github.com/brainelectronics/micropython-i2c-lcd/actions/workflows/release.yml/badge.svg)](https://github.com/brainelectronics/micropython-i2c-lcd/actions/workflows/release.yml)
 
-Micropython package to control HD44780 LCD displays 1602 and 2004 via I2C
+MicroPython package to control HD44780 LCD displays 1602 and 2004 via I2C
 
 ---------------
 
 ## General
 
-Micropython package to control HD44780 LCD displays 1602 and 2004 via I2C
+MicroPython package to control HD44780 LCD displays 1602 and 2004 via I2C
 
 📚 The latest documentation is available at
 [MicroPython I2C LCD ReadTheDocs][ref-rtd-micropython-i2c-lcd] 📚
@@ -65,6 +65,7 @@ Connect the MicroPython device to a network (if possible)
 ```python
 import network
 station = network.WLAN(network.STA_IF)
+station.active(True)
 station.connect('SSID', 'PASSWORD')
 station.isconnected()
 ```
@@ -158,13 +159,14 @@ cp examples/boot.py /pyboard
 from lcd_i2c import LCD
 from machine import I2C, Pin
 
-I2C_ADDR = 0x27
+# PCF8574 on 0x50
+I2C_ADDR = 0x27     # DEC 39, HEX 0x27
 NUM_ROWS = 2
 NUM_COLS = 16
 
 # define custom I2C interface, default is 'I2C(0)'
 # check the docs of your device for further details and pin infos
-i2c = I2C(1, scl=Pin(3), sda=Pin(2), freq=800_000)
+i2c = I2C(0, scl=Pin(13), sda=Pin(12), freq=800000)
 lcd = LCD(addr=I2C_ADDR, cols=NUM_COLS, rows=NUM_ROWS, i2c=i2c)
 
 lcd.begin()

changelog.md

@@ -17,6 +17,11 @@ r"^\#\# \[\d{1,}[.]\d{1,}[.]\d{1,}\] \- \d{4}\-\d{2}-\d{2}$"
 -->
 
 ## Released
+## [0.1.1] - 2023-06-12
+### Fixed
+- Usage documentation with more comments and WiFi instructions in root README
+- Validate `package.json` file in test workflow
+
 ## [0.1.0] - 2023-03-09
 ### Added
 - `const.py`, `display.py` and `typing.py` in `lcd_i2c` module
@@ -29,6 +34,7 @@ r"^\#\# \[\d{1,}[.]\d{1,}[.]\d{1,}\] \- \d{4}\-\d{2}-\d{2}$"
 - Not used files provided with [template repo](https://github.com/brainelectronics/micropython-i2c-lcd)
 
 <!-- Links -->
-[Unreleased]: https://github.com/brainelectronics/micropython-i2c-lcd/compare/0.1.0...main
+[Unreleased]: https://github.com/brainelectronics/micropython-i2c-lcd/compare/0.1.1...main
 
-[0.1.0]: https://github.com/brainelectronics/micropython-i2c-lcd/tree/0.6.0
+[0.1.1]: https://github.com/brainelectronics/micropython-i2c-lcd/tree/0.1.1
+[0.1.0]: https://github.com/brainelectronics/micropython-i2c-lcd/tree/0.1.0

docs/EXAMPLES.md

@@ -15,13 +15,15 @@ An example of all implemented functionalities can be found at the
 from lcd_i2c import LCD
 from machine import I2C, Pin
 
+# PCF8574 on 0x27
 I2C_ADDR = 0x27
 NUM_ROWS = 2
 NUM_COLS = 16
 
 # define custom I2C interface, default is 'I2C(0)'
 # check the docs of your device for further details and pin infos
-i2c = I2C(1, scl=Pin(3), sda=Pin(2), freq=800_000)
+# this are the pins for the Raspberry Pi Pico adapter board
+i2c = I2C(0, scl=Pin(13), sda=Pin(12), freq=800000)
 lcd = LCD(addr=I2C_ADDR, cols=NUM_COLS, rows=NUM_ROWS, i2c=i2c)
 
 # get LCD infos/properties

docs/index.rst

@@ -1,4 +1,4 @@
-Micropython package to control HD44780 LCD displays via I2C
+MicroPython package to control HD44780 LCD displays via I2C
 ===========================================================
 
 Contents

examples/main.py

@@ -7,7 +7,8 @@
 from machine import I2C, Pin
 from time import sleep
 
-I2C_ADDR = 0x27
+# PCF8574 on 0x27
+I2C_ADDR = 0x27     # DEC 39, HEX 0x27
 I2C_NUM_ROWS = 2
 I2C_NUM_COLS = 16
 FREQ = 800000   # Try lowering this value in case of "Errno 5"
@@ -28,7 +29,8 @@ def print_and_wait(text: str, sleep_time: int = 2) -> None:
 
 # define custom I2C interface, default is 'I2C(0)'
 # check the docs of your device for further details and pin infos
-i2c = I2C(1, scl=Pin(3), sda=Pin(2), freq=FREQ)
+# this are the pins for the Raspberry Pi Pico adapter board
+i2c = I2C(0, scl=Pin(13), sda=Pin(12), freq=FREQ)
 lcd = LCD(addr=I2C_ADDR, cols=I2C_NUM_COLS, rows=I2C_NUM_ROWS, i2c=i2c)
 
 # get LCD infos/properties
@@ -155,4 +157,5 @@ def print_and_wait(text: str, sleep_time: int = 2) -> None:
 
 # show custom char stored at location 0
 lcd.print(chr(0))
+lcd.print(chr(0))
 print_and_wait("Show custom char")

package.json

@@ -21,7 +21,6 @@
             "github:brainelectronics/micropython-i2c-lcd/lcd_i2c/version.py"
         ]
     ],
-    "deps": [
-    ],
+    "deps": [],
     "version": "0.1.0"
 }

requirements-test.txt

@@ -4,3 +4,4 @@ flake8>=5.0.0,<6
 coverage>=6.4.2,<7
 nose2>=0.12.0,<1
 yamllint>=1.29,<2
+setup2upypackage>=0.2.0,<1

setup.py

@@ -16,7 +16,7 @@
 setup(
     name='micropython-i2c-lcd',
     version=__version__,
-    description="Micropython package to control HD44780 LCD displays 1602 and 2004 ",
+    description="MicroPython package to control HD44780 LCD displays 1602 and 2004",
     long_description=long_description,
     long_description_content_type='text/markdown',
     url='https://github.com/brainelectronics/micropython-i2c-lcd',
@@ -26,8 +26,9 @@
         'Development Status :: 4 - Beta',
         'Intended Audience :: Developers',
         'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python :: Implementation :: MicroPython',
     ],
-    keywords='micropython, HD44780, I2C, display, LCD1602, LCD2004',
+    keywords='micropython, HD44780, I2C, display, LCD1602, LCD2004, PCF8574',
     project_urls={
         'Bug Reports': 'https://github.com/brainelectronics/micropython-i2c-lcd/issues',
         'Source': 'https://github.com/brainelectronics/micropython-i2c-lcd',