Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/brainelectronics/micropython-eeprom

MicroPython driver for AT24Cxx EEPROM
https://github.com/brainelectronics/micropython-eeprom

at24cxx eeprom library micropython micropython-lib

Last synced: 29 days ago
JSON representation

MicroPython driver for AT24Cxx EEPROM

Awesome Lists containing this project

README 

        
# MicroPython EEPROM



[![Downloads](https://pepy.tech/badge/micropython-eeprom)](https://pepy.tech/project/micropython-eeprom)

![Release](https://img.shields.io/github/v/release/brainelectronics/micropython-eeprom?include_prereleases&color=success)

![MicroPython](https://img.shields.io/badge/micropython-Ok-green.svg)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![codecov](https://codecov.io/github/brainelectronics/micropython-eeprom/branch/main/graph/badge.svg)](https://app.codecov.io/github/brainelectronics/micropython-eeprom)

[![CI](https://github.com/brainelectronics/micropython-eeprom/actions/workflows/release.yml/badge.svg)](https://github.com/brainelectronics/micropython-eeprom/actions/workflows/release.yml)



MicroPython driver for AT24Cxx EEPROM



---------------



## General



MicroPython driver for AT24Cxx EEPROM



📚 The latest documentation is available at

[MicroPython EEPROM ReadTheDocs][ref-rtd-micropython-eeprom] 📚



- [Installation](#installation)

    - [Install required tools](#install-required-tools)

- [Setup](#setup)

    - [Install package with upip](#install-package-with-upip)

        - [General](#general)

        - [Specific version](#specific-version)

        - [Test version](#test-version)

    - [Manually](#manually)

        - [Upload files to board](#upload-files-to-board)

- [Usage](#usage)

- [Contributing](#contributing)

    - [Unittests](#unittests)

- [Credits](#credits)



## Installation



### Install required tools



Python3 must be installed on your system. Check the current Python version

with the following command



```bash

python --version

python3 --version

```



Depending on which command `Python 3.x.y` (with x.y as some numbers) is

returned, use that command to proceed.



```bash

python3 -m venv .venv

source .venv/bin/activate



pip install -r requirements.txt

```



## Setup



### Install package with upip



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()

```



#### General



Install the latest package version of this lib on the MicroPython device



```python

import mip

mip.install("github:brainelectronics/micropython-eeprom")

```



For MicroPython versions below 1.19.1 use the `upip` package instead of `mip`



```python

import upip

upip.install('micropython-eeprom')

```



#### Specific version



Install a specific, fixed package version of this lib on the MicroPython device



```python

import mip

# install a verions of a specific branch

mip.install("github:brainelectronics/micropython-eeprom", version="feature/initial-implementation")

# install a tag version

mip.install("github:brainelectronics/micropython-eeprom", version="0.1.0")

```



For MicroPython versions below 1.19.1 use the `upip` package instead of `mip`



```python

import upip

upip.install('micropython-eeprom')

```



#### Test version



Install a specific release candidate version uploaded to

[Test Python Package Index](https://test.pypi.org/) on every PR on the

MicroPython device. If no specific version is set, the latest stable version

will be used.



```python

import mip

mip.install("github:brainelectronics/micropython-eeprom", version="0.1.0-rc1.dev1")

```



For MicroPython versions below 1.19.1 use the `upip` package instead of `mip`



```python

import upip

# overwrite index_urls to only take artifacts from test.pypi.org

upip.index_urls = ['https://test.pypi.org/pypi']

upip.install('micropython-eeprom')

```



See also [brainelectronics Test PyPi Server in Docker][ref-brainelectronics-test-pypiserver]

for a test PyPi server running on Docker.



### Manually



#### Upload files to board



Copy the module to the MicroPython board and import them as shown below

using [Remote MicroPython shell][ref-remote-upy-shell]



Open the remote shell with the following command. Additionally use `-b 115200`

in case no CP210x is used but a CH34x.



```bash

rshell --port /dev/tty.SLAB_USBtoUART --editor nano

```



Perform the following command inside the `rshell` to copy all files and

folders to the device



```bash

mkdir /pyboard/lib

mkdir /pyboard/lib/eeprom



cp eeprom/* /pyboard/lib/eeprom



cp examples/main.py /pyboard

cp examples/boot.py /pyboard

```



## Usage



```python

from eeprom import EEPROM

from machine import I2C, Pin



I2C_ADDR = 0x50     # DEC 80, HEX 0x50

EEPROM_SIZE = 32    # AT24C32 on 0x50



# define custom I2C interface, default is 'I2C(0)'

# check the docs of your device for further details and pin infos

i2c = I2C(0, scl=Pin(13), sda=Pin(12), freq=800000)

eeprom = EEPROM(addr=I2C_ADDR, at24x=EEPROM_SIZE, i2c=i2c)



# write 'micropython' to address 10

eeprom.write(10, 'micropython')



# read 11 bytes starting at address 10

eeprom.read(10, 11)



# update content at address 10 with 'MicroPython'

# only changed values are written, here 'm' -> 'M' and 'p' -> 'P'

eeprom.write(10, 'MicroPython')

```



## Contributing



### Unittests



Run the unittests locally with the following command after installing this

package in a virtual environment



```bash

# run all tests

nose2 --config tests/unittest.cfg



# run only one specific tests

nose2 tests.test_eeprom.TestEEPROM.test_addr

```



Generate the coverage files with



```bash

python create_report_dirs.py

coverage html

```



The coverage report is placed at `reports/coverage/html/index.html`



## Credits



Based on

[Mike Causer's MicroPython TinyRTC I2C module][ref-micropython-tinyrtc-i2c]

and the [PyPa sample project][ref-pypa-sample]



[ref-rtd-micropython-eeprom]: https://micropython-eeprom.readthedocs.io/en/latest/

[ref-remote-upy-shell]: https://github.com/dhylands/rshell

[ref-brainelectronics-test-pypiserver]: https://github.com/brainelectronics/test-pypiserver

[ref-micropython-tinyrtc-i2c]: https://github.com/mcauser/micropython-tinyrtc-i2c

[ref-pypa-sample]: https://github.com/pypa/sampleproject

[ref-test-pypi]: https://test.pypi.org/

[ref-pypi]: https://pypi.org/