i2c-eeproms

v1.0.0

Published

a year ago

Support for I2C access of various AT24XXX I2C EEPROMS

Node.js I2C access for various AT24CXXX EEPROMS

This module supports the following I2C EEPROMs:

| EEPROM | Vendor | ------------- | --------------- | :-------------: | AT24C01 | Atmel/Microchip | | AT24C02 | Atmel/Microchip | | AT24C04 | Atmel/Microchip | | AT24C08 | Atmel/Microchip | | AT24C16 | Atmel/Microchip | | AT24C32 | Atmel/Microchip | | AT24C32C | Atmel/Microchip | | AT24C64 | Atmel/Microchip | | AT24C64C | Atmel/Microchip | | AT24C128 | Atmel/Microchip | | AT24C128C | Atmel/Microchip | | AT24C256 | Atmel/Microchip | | AT24C256C | Atmel/Microchip | | K24C256C | K-Line | AT24C512 | Atmel/Microchip | | AT24C512C | Atmel/Microchip | | AT24CM01 | Atmel/Microchip | | AT24CM02 | Atmel/Microchip | | Size (bits) | Page Count | Page Size (bytes) | Total Size (bytes) | Write Delay(ms) | Devices/Bus | | :------------: | :-------------------: | :--------------------: | :-----------------: | :---------: | 1Kb | 16 | 8 | 128 | 5 | 8 | 2Kb | 32 | 8 | 256 | 5 | 8 | 4Kb | 32 | 16 | 512 | 5 | 4 | 8Kb | 64 | 16 | 1024 | 5 | 2 | 16Kb | 128 | 16 | 2048 | 5 | 1 | 32Kb | 128 | 32 | 4096 | 10 | 8 | 32Kb | 128 | 32 | 4096 | 5 | 8 | 64Kb | 256 | 32 | 8192 | 10 | 8 | 64Kb | 256 | 32 | 8192 | 5 | 8 | 128Kb | 256 | 64 | 16384 | 10 | 4 | 128Kb | 256 | 64 | 16384 | 5 | 8 | 256Kb | 512 | 64 | 32768 | 10 | 4 | 256Kb | 512 | 64 | 32768 | 5 | 8 | | 256Kb | 512 | 64 | 32768 | 5 | 8 | 512Kb | 512 | 128 | 65536 | 10 | 4 | 512Kb | 512 | 128 | 65536 | 5 | 8 | 1Mb | 512 | 256 | 131072 | 5 | 4 | 2Mb | 1024 | 256 | 262144 | 5 | 2 |

**Note that the'C' revision of chips have a lower post-write delay requirement and may support more concurrent devices per bus. **
For example, the AT24C32C chip has a 5ms post-write delay compared to 10ms for the AT24C32.
For example, the AT24C128/256/512C chip supports a maximum of 8 devices per bus compared to 4 for the AT24C128/256/512.
The K24C256C chip is a Chinese Brand delivered on a board purchased from Amazon US stating that it contained AT24C256. It is functionally identical to the AT24C256C.

Web Sites and Data Sheets

Various web sites were and data sheets were referenced during the development of this module. Links are provided below for convenience.

.NET nanoFramework API Reference Device Details Internet

AT24C01A/AT24C02/AT24C04/AT24C08A/AT24C16A datasheet from Microchip AT24C01 datasheet from Mouser Electronics USA AT24C01D/AT24C02D (Low Voltage - max 3.6V) datasheet from Microchip AT24C08D (Low Voltage - max 3.6V) datasheet from Microchip

AT24C32/AT24C64 datasheet from Microchip AT24C32C/AT24C64C datasheet from Microchip

AT24C128/AT24C256 datasheet from Microchip AT24C128C/AT24C256C datasheet from Microchip AT24C128C datasheet from Microchip AT24C256C datasheet from Microchip

AT24C512C datasheet from Microchip AT24CM01 datasheet from Microchip AT24CM02 datasheet from Microchip

K24C256C datasheet from K-Line

Supported Node.js versions

Supported (tested) Node.js versions: 10, 12, 14, 16, 18, 20

Installation

npm install i2c-eeproms

TypeScript typings are included in this package.

You should be able to use this module on any Linux based OS that support i2c-bus.

Example

This module requires an IC2Bus or Promisified bus instance to operate. Construct the i2c-bus object and pass it in the constructor along with the I2C address of the expander chip.

The AT24C256C example below can be found in the examples directory of this package together with a TypeScript example.

// Import the EEPROM class
//const ChipConstructor = require('i2c-eeproms').AT24C256C;
const ChipConstructor = require('../').AT24C256C;

// Import the i2c-bus module
const { openSync: I2CBusOpenSync, openPromisified: I2CBusOpenPromisified } = require('i2c-bus');

const example = async () => {
    // Adjust for your Raspberry Pi or other device
    const busNumber = 1;
    // Adjust for your EEPROM's address - for address 0x50, specify 0x50, for address 0x57, specify 0x57.
    // Some chips don't support 8 distinct addresses on the bus and as such an error will be thrown during construction.
    const i2cAddress = 0x50;

    // This library can accept either an I2CBus or a PromisifiedBus as an input parameter
    const i2cBus = await I2CBusOpenPromisified(busNumber);
    const chip = new ChipConstructor(i2cBus, i2cAddress);

    // Create text that is larger than 2 pages of an EEPROM
    const textIn = '00:0123456789@ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz{|}~' +
        '01!#?$%&()*+,-./0123456789:;<->?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^abcdefghijklmnopqrstuvwxyz{|}~' +
        '02!#?$%&()*+,-./0123456789:;<->?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^abcdefghijklmnopqrstuvwxyz{|}~' +
        '03!#?$%&()*+,-./0123456789:;<->?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^abcdefghijklmnopqrstuvwxyz{|}~' +
        '04!#?$%&()*+,-./0123456789:;<->?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^abcdefghijklmnopqrstuvwxyz{|}~' +
        '05!#?$%&()*+,-./0123456789:;<->?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^abcdefghijklmnopqrstuvwxyz{|}~' +
        '06!#?$%&()*+,-./0123456789:;<->?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^abcdefghijklmnopqrstuvwxyz{|}~' +
        '07!#?$%&()*+,-./0123456789:;<->?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^abcdefghijklmnopqrstuvwxyz{|}~';

    console.log('Read/Write Test for chip:%s', chip.name);
    const maxAddress = chip.storageSizeInBytes;
    // Writes to the chip are not limited to the maximum page size the EEPROM supports.
    // Page writes are managed internally by the EEPROM implementation.
    const blockSize = chip.pageSizeInBytes * 2;

    const maxLoops = 2;
    let loopCount = 0;

    while1: while (loopCount++ < maxLoops) {
        for (let address = 0x00; address < maxAddress; address += blockSize) {
            console.log('loopCount:%o address:0x%s', loopCount, address.toString(16).padStart(4, '0'));
            const toWrite = textIn.substring(0, blockSize);
            const bytesWritten = await chip.writeDataBlock(address, toWrite);
            const readResult = await chip.readDataBlock(address, bytesWritten);
            const textOut = readResult.toString('utf-8');
            if (textOut != toWrite) {
                console.log('Read/Write Text Mismatch!.  read:"%s"', textOut);
                break while1;
            }
        }
    }

    console.log('Clearing EEPROM with 0x00s');
    const bufferWithNulls = Buffer.alloc(blockSize);
    for (let address = 0x00; address < maxAddress; address += blockSize) {
        console.log('address:0x%s', address.toString(16).padStart(4, '0'));
        const bytesWritten = await chip.writeDataBlock(address, bufferWithNulls);
        const readResult = await chip.readDataBlock(address, bytesWritten);
        for (let i = 0; i < readResult.byteLength; i++) {
            if (readResult[i] !== 0x00) {
                console.log('Failed to clear EEPROM Memory');
                break;
            }
        }
    }
    await i2cBus.close();
};

// Run the example
example().catch(console.error);

Usage

**Users may construct instances of chips by supplying 2 parameters;0 An 'i2cBus' and an 'i2address'. If the value specified for i2cAddress is not allowed based on the chip type, an error will be thrown. The error message provides detailed information as to the allowed I2C addresses for the chip type selected. **

Note that all of the chips in this module support a common I2C address of 0x50.

Constructors