Add MIP package

Author: mcauser

examples/basic_bitbang.py

@@ -0,0 +1,44 @@
+# SPDX-FileCopyrightText: 2021 Mike Causer <https://github.com/mcauser>
+# SPDX-License-Identifier: MIT
+
+"""
+MicroPython 74HC595 8-Bit Shift Register
+https://github.com/mcauser/micropython-74hc595
+"""
+
+from machine import Pin
+from sr74hc595 import SR74HC595_BITBANG
+
+ser = Pin(23, Pin.OUT)
+rclk = Pin(5, Pin.OUT)
+srclk = Pin(18, Pin.OUT)
+
+# construct without optional pins
+sr = SR74HC595_BITBANG(ser, srclk, rclk)
+
+sr.clear()  # raises RuntimeError because you haven't provide srclr pin
+sr.enable() # raises RuntimeError because you haven't provide oe pin
+
+# reconstruct with all pins
+oe = Pin(33, Pin.OUT, value=0)    # low enables output
+srclr = Pin(32, Pin.OUT, value=1) # pulsing low clears data
+
+sr = SR74HC595_BITBANG(ser, srclk, rclk, srclr, oe)
+
+sr.bit(1)  # send high bit, do not latch yet
+sr.bit(0)  # send low bit, do not latch yet
+sr.latch() # latch outputs, outputs=0000_0010
+
+sr.bit(1, 1) # send high bit and latch, outputs=0000_0101
+sr.bit(0, 1) # send low bit and latch, outputs=0000_1010
+
+sr.bits(0xff, 4) # send 4 lowest bits of 0xff (sends 0x0f), outputs=1010_1111
+
+sr.clear(0) # clear the memory but don't latch yet
+sr.latch()  # next latch shows the outputs have been reset
+
+sr.bits(0b1010_1010, 8) # write some bits
+sr.clear()  # clear the memory and latch, outputs have been reset
+
+sr.enable()  # outputs enabled
+sr.enable(0) # outputs disabled

examples/basic_spi.py

@@ -0,0 +1,35 @@
+# SPDX-FileCopyrightText: 2021 Mike Causer <https://github.com/mcauser>
+# SPDX-License-Identifier: MIT
+
+"""
+MicroPython 74HC595 8-Bit Shift Register
+https://github.com/mcauser/micropython-74hc595
+"""
+
+from machine import Pin, SPI
+from sr74hc595 import SR74HC595_SPI
+
+spi = SPI(1, 100000)
+rclk = Pin(5, Pin.OUT)
+
+oe = Pin(33, Pin.OUT, value=0)    # low enables output
+srclr = Pin(32, Pin.OUT, value=1) # pulsing low clears data
+
+sr = SR74HC595_SPI(spi, rclk, 2) # chain of 2 shift registers
+
+sr.pin(2,1)  # set pin 2 high of furthest shift register
+sr.pin(2)    # read pin 2
+sr.pin(2,0)  # set pin 2 low
+
+sr.toggle(8) # toggle first pin of closest shift register
+
+sr[0] = 0xff # set all pins high on furthest shift register
+sr[1] = 240  # set half pins high on closest shift register
+sr[1]        # read pins
+
+oe.value(0)  # disable outputs
+oe.value(1)  # enable outputs
+
+# pulse to clear shift register memory
+srclr.value(1)
+srclr.value(0)

examples/package.json

@@ -0,0 +1,8 @@
+{
+  "urls": [
+    ["sr74hc595/examples/basic_bitbang.py", "github:mcauser/micropython-74hc595/examples/basic_bitbang.py"],
+    ["sr74hc595/examples/basic_spi.py", "github:mcauser/micropython-74hc595/examples/basic_spi.py"]
+  ],
+  "deps": [],
+  "version": "1.0.0"
+}

package.json

@@ -0,0 +1,9 @@
+{
+  "urls": [
+    ["sr74hc595/__init__.py", "github:mcauser/micropython-74hc595/src/__init__.py"],
+    ["sr74hc595/sr74hc595_bitbang.py", "github:mcauser/micropython-74hc595/src/sr74hc595_bitbang.py"],
+    ["sr74hc595/sr74hc595_spi.py", "github:mcauser/micropython-74hc595/src/sr74hc595_spi.py"]
+  ],
+  "deps": [],
+  "version": "1.0.0"
+}

readme.md

@@ -3,30 +3,54 @@
 A MicroPython library for 74HC595 8-bit shift registers.
 
 There's both an SPI version and a bit-bang version, each with a slightly
-different interface.
+different interface. See below.
 
 ![demo](docs/demo.jpg)
 
+
+### Installation
+
+Using mip via mpremote:
+
+```bash
+$ mpremote mip install github:mcauser/micropython-74hc595
+$ mpremote mip install github:mcauser/micropython-74hc595/examples
+```
+
+Using mip directly on a WiFi capable board:
+
+```python
+>>> import mip
+>>> mip.install("github:mcauser/micropython-74hc595")
+>>> mip.install("github:mcauser/micropython-74hc595/examples")
+```
+
+Manual installation:
+
+Copy `src/sr74hc595_bitbang.py` and `src/sr74hc595_spi.py` to the root directory of your device.
+
+
 ## SPI Version
 
 You can use either HSPI or SPI. This version is significantly faster than the
 bit-bang version, but is limited to writing whole bytes of data.
 
+
 ### SPI Example
 
 **Basic Usage**
 
 ```python
 from machine import Pin, SPI
-from sr_74hc595_spi import SR
+from sr74hc595 import SR74HC595_SPI
 
 spi = SPI(1, 100000)
 rclk = Pin(5, Pin.OUT)
 
 oe = Pin(33, Pin.OUT, value=0)    # low enables output
 srclr = Pin(32, Pin.OUT, value=1) # pulsing low clears data
 
-sr = SR(spi, rclk, 2) # chain of 2 shift registers
+sr = SR74HC595_SPI(spi, rclk, 2) # chain of 2 shift registers
 
 sr.pin(2,1)  # set pin 2 high of furthest shift register
 sr.pin(2)    # read pin 2
@@ -120,14 +144,14 @@ at the expense of the performance you get using SPI.
 
 ```python
 from machine import Pin
-from sr_74hc595_bitbang import SR
+from sr74hc595 import SR74HC595_BITBANG
 
 ser = Pin(23, Pin.OUT)
 rclk = Pin(5, Pin.OUT)
 srclk = Pin(18, Pin.OUT)
 
 # construct without optional pins
-sr = SR(ser, srclk, rclk)
+sr = SR74HC595_BITBANG(ser, srclk, rclk)
 
 sr.clear()  # raises RuntimeError because you haven't provide srclr pin
 sr.enable() # raises RuntimeError because you haven't provide oe pin
@@ -136,7 +160,7 @@ sr.enable() # raises RuntimeError because you haven't provide oe pin
 oe = Pin(33, Pin.OUT, value=0)    # low enables output
 srclr = Pin(32, Pin.OUT, value=1) # pulsing low clears data
 
-sr = SR(ser, srclk, rclk, srclr, oe)
+sr = SR74HC595_BITBANG(ser, srclk, rclk, srclr, oe)
 
 sr.bit(1)  # send high bit, do not latch yet
 sr.bit(0)  # send low bit, do not latch yet
@@ -209,6 +233,7 @@ the current state of the `ser` pin and copy it to the shift register memory.
 _clock()
 ```
 
+
 ## Chaining
 
 You can connect multiple 74HC595 shift registers together to form a chain.
@@ -225,11 +250,13 @@ The `QH\`` output pin on the first shift register goes into the next shift regis
 When clocking in data, the values appear on the closest shift register to the
 micro controller first, before overflowing into each chained shift register.
 
+
 ## Parts
 
-* [TinyPICO](https://www.tinypico.com/) $20.00 USD
-* [74HC595 DIP-16](https://www.aliexpress.com/item/32834183196.html) $0.77 AUD - 10pcs
-* [74HC595 breakout](https://www.aliexpress.com/item/32807747744.html) $0.88 AUD
+* [TinyPICO](https://www.tinypico.com/)
+* [74HC595 DIP-16](https://s.click.aliexpress.com/e/_DnLBdpL)
+* [74HC595 breakout](https://s.click.aliexpress.com/e/_Der4vyZ)
+
 
 ## Connections
 
@@ -253,12 +280,14 @@ SRCLR | Shift Register Clear   | Active low. Drive high to clear contents.
 QA-QH | Outputs                | 8 output pins
 QH\`  | Serial Output          | Connect to the next 74HC595 SER pin
 
+
 ## Links
 
 * [TinyPICO Getting Started](https://www.tinypico.com/gettingstarted)
 * [micropython.org](http://micropython.org)
 * [74HC595 datasheet](docs/sn74hc595n.pdf)
 
+
 ## License
 
 Licensed under the [MIT License](http://opensource.org/licenses/MIT).

src/__init__.py

@@ -0,0 +1,10 @@
+# SPDX-FileCopyrightText: 2021 Mike Causer <https://github.com/mcauser>
+# SPDX-License-Identifier: MIT
+
+"""
+MicroPython 74HC595 8-Bit Shift Register
+https://github.com/mcauser/micropython-74hc595
+"""
+
+from .sr74hc595_bitbang import SR74HC595_BITBANG
+from .sr74hc595_spi import SR74HC595_SPI

sr_74hc595_bitbang.py renamed to src/sr74hc595_bitbang.py

@@ -1,32 +1,14 @@
+# SPDX-FileCopyrightText: 2021 Mike Causer <https://github.com/mcauser>
+# SPDX-License-Identifier: MIT
+
 """
 MicroPython 74HC595 8-Bit Shift Register
 https://github.com/mcauser/micropython-74hc595
-
-MIT License
-Copyright (c) 2021 Mike Causer
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
 """
 
-__version__ = '0.0.1'
+__version__ = '1.0.0'
 
-class SR:
+class SR74HC595_BITBANG:
     def __init__(self, ser, srclk, rclk, srclr=None, oe=None):
         self.ser = ser
         self.srclk = srclk

sr_74hc595_spi.py renamed to src/sr74hc595_spi.py

@@ -1,32 +1,14 @@
+# SPDX-FileCopyrightText: 2021 Mike Causer <https://github.com/mcauser>
+# SPDX-License-Identifier: MIT
+
 """
 MicroPython 74HC595 8-Bit Shift Register
 https://github.com/mcauser/micropython-74hc595
-
-MIT License
-Copyright (c) 2021 Mike Causer
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
 """
 
-__version__ = '0.0.1'
+__version__ = '1.0.0'
 
-class SR:
+class SR74HC595_SPI:
     def __init__(self, spi, rclk, len=1, srclr=None, oe=None):
         self.spi = spi
         self.rclk = rclk