Custom Arduino Driver for Battery Gas Gauging Device BQ28Z610

Arduino BQ28Z610 Driver

This is a driver for Arduino that provides functions to interface with the BQ28Z610 battery gas gauge device over I2C protocol. With this driver, you can operate the BQ28Z610 device via the serial port from your computer using Arduino.

Functions were implemented based on the documentation:

Not all functions described in the Technical Reference Manual were implemented, but most of them.

The driver also includes some additional service functions for more usability.

Project Files

  • bq28z610-arduino-driver.ino
  • doxyfile
  • std_data_commands.h, std_data_commands.cpp
  • alt_manufacturer_access.h, alt_manufacturer_access.cpp
  • data_flash_access.h, data_flash_access.cpp
  • service.h, service.cpp
  • utils.h, utils.cpp
  • flags.h
  • globals.h

/extras/data_flash/:

  • data_flash.py
  • data/data_descriptions.csv
  • Dump files

Next, I will provide a brief description of the file contents. For a complete description of all functions, follow the link: https://asilichenko.github.io/bq28z610-arduino-driver/files.html

📄 bq28z610-arduino-driver.ino

The main Arduino sketch file.

There is some sample code in the setup function:

  • Calling "read and print" functions from different sections.
  • Example of using the SILENCE constant and printing the results of the called functions.

An example of the output result in the serial port from executing this code can be viewed at the link: /extras/example-output.txt

📄 doxyfile

This file describes the settings to be used by the documentation system doxygen (www.doxygen.org) for a project.

Output directory for the generated documentation is "/docs/".

📄 std_data_commands

Functions described in the section "12.1 Standard Data Commands" of the Technical Reference Manual.

📄 alt_manufacturer_access

Functions described in the section "12.2 0x3E, 0x3F AltManufacturerAccess()" of the Technical Reference Manual.

📄 data_flash_access

Functions to read data from the Data Flash and write to the Data Flash, according to:

  • 12.2.45 Data Flash Access() 0x4000–0x5FFF
  • 13 Data Flash Values
  • 14 Data Flash Summary

To access the data flash, your device needs to be in an UNSEALED state (UNSEALED is enough; Full Access state is not necessary).

The default Unseal Key is defined in the class DeviceSecurity in the file globals.h.

Contains such constants and functions as:

  • Data Flash addresses constants
  • Read and write single byte, word and array (maximum 32 bytes)
  • Read data in the String format
  • Read and write values for named Data Flash data
  • Print Ra Table
  • Reset Ra Table flags
  • Print Data Flash dump

The Technical Reference Manual only contains descriptions up to address 0x4727, but there is some data in the rest of the Data Flash.

Some addresses within the standard region are prohibited from writing, although I am not sure about the exact ranges of these addresses. For example, around the address 0x5A5A, there is no data (bytes are 0xFF) and they cannot be overwritten.

📄 service

Additional service functions for the device, like:

📄 utils

Util functions for:

  • Printing into serial port
  • Composing full values from bytes
  • Sending and receiving data via I2C protocol
  • Implementation of the high-level Block Protocol of the device

📄 flags.h

Definition of the flag constants with the descriptions.

📄 globals.h

Definition of the global constants except flags, like:

  • I2C address of the Device
  • Security modes
  • Unseal keys
  • Block protocol parameters
  • Codes of the "12.1 Standard Data Commands"
  • Codes of the "12.2 0x3E, 0x3F Alt Manufacturer Access Commands"
  • Constants for some raw data commands like DAStatus and ITStatus
  • Strings that represent units of measurement

📄 data_flash.py

Python script for processing the Data Flash dump, printed by the function from the data_flash_access:

  • Load from the text file
  • Print data detailed - values with addresses and captions from the "14.1 Data Flash Table" of the Technical Manual
  • Compare two dumps and print the differences

📄 data_descriptions.csv

Csv-file which contains list of Data Flash entities taken from the table "14.1 Data Flash Table":

  • Physical address
  • Data format (I4, U2, H1, F4, S5, etc.) that represents column "Type"
  • Description which is a join of the columns: "Class", "Subclass" and "Name" separated by "/" symbol

📂 Dump files

I included several dump files of my BQ28Z610 device:

Arduino Nano Connection

  • GND -> black
  • A4 = SDA -> white
  • A5 = SCL -> yellow

References

Sources

at
Labels: , ,

No comments:

Post a Comment

Subscribe to: Post Comments (Atom)

Desperate Housewives Susan's Art s05 e16

Desperate Housewives Susan's Art s05 e16