alex/GY-63_MS5611
1
0
Fork 0
mirror of https://github.com/RobTillaart/Arduino.git synced 2024-09-20 00:55:58 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity
328f724f17
GY-63_MS5611/libraries/FRAM_I2C
History
rob tillaart 7eb4224bf1 0.3.2 FRAM_I2C
2021-12-18 15:02:32 +01:00
..
.github/workflows 0.3.2 FRAM_I2C 2021-12-18 15:02:32 +01:00
examples 0.3.2 FRAM_I2C 2021-12-18 15:02:32 +01:00
test 0.3.2 FRAM_I2C 2021-12-18 15:02:32 +01:00
.arduino-ci.yml 0.3.2 FRAM_I2C 2021-12-18 15:02:32 +01:00
FRAM.cpp 0.3.2 FRAM_I2C 2021-12-18 15:02:32 +01:00
FRAM.h 0.3.2 FRAM_I2C 2021-12-18 15:02:32 +01:00
keywords.txt 0.3.2 FRAM_I2C 2021-12-18 15:02:32 +01:00
library.json 0.3.2 FRAM_I2C 2021-12-18 15:02:32 +01:00
library.properties 0.3.2 FRAM_I2C 2021-12-18 15:02:32 +01:00
LICENSE 0.3.2 FRAM_I2C 2021-12-18 15:02:32 +01:00
README.md 0.3.2 FRAM_I2C 2021-12-18 15:02:32 +01:00

README.md

Arduino CI Arduino-lint JSON check License: MIT GitHub release

FRAM_I2C

Arduino library for I2C FRAM

Description

FRAM is a library to read and write (over I2C) to an FRAM module. FRAM is much faster than EEPROM and almost as fast as Arduino UNO RAM. Another important feature is that FRAM keeps its content after a reboot (non-volatile)

FRAM stands for Ferroelectric RAM - https://en.wikipedia.org/wiki/Ferroelectric_RAM

Types of FRAM the library should work with

SIZE TYPE
8KB MB85RC64T
32KB MB85RC256V
64KB MB85RC512T
128KB MB85RC1MT

Address = 0x50 (default) .. 0x57

Interface

Constructor

  • FRAM(TwoWire *wire = &Wire) Constructor with optional Wire interface.
  • int begin(uint8_t address = 0x50, int8_t writeProtectPin = -1) address and writeProtectPin is optional.
  • int begin(uint8_t sda, uint8_t scl, uint8_t address = 0x50, int8_t writeProtectPin = -1) idem fro ESP32 a.o.
  • bool isConnected() checks if the address is visible on the I2C bus.

Write & read

Support for basic types and 2 calls for generic object

  • void write8(uint16_t memaddr, uint8_t value) uint8_t
  • void write16(uint16_t memaddr, uint16_t value) uint16_t
  • void write32(uint16_t memaddr, uint32_t value) uint32_t
  • void write(uint16_t memaddr, uint8_t * obj, uint16_t size) other types / sizes
  • uint8_t read8(uint16_t memaddr)
  • uint16_t read16(uint16_t memaddr)
  • uint32_t read32(uint16_t memaddr)
  • void read(uint16_t memaddr, uint8_t uint8_t * obj, uint16_t size)

Miscellaneous

  • bool setWriteProtect(bool b) make the FRAM write-protected by pulling line HIGH / LOW.
    Returns true if a writeProtectPin was defined. Otherwise the FRAM cannot be write protected.
  • bool getWriteProtect() get current status.
  • uint16_t getManufacturerID() idem.
  • uint16_t getProductID() idem.
  • uint16_t getSize() returns size in KB.

Operational

See examples

Future

  • test
  • extend examples
  • example in which FRAM is used as buffer for some stream?
  • example FRAM ring buffer