Mirror of jamesbowman/i2cdriver@github.com - Firmware and software for the I2CDriver board
Go to file
James Bowman 6e0696e0bf Fix link 2023-02-07 15:00:50 -08:00
c Add capture mode support to API and i2ccl 2020-03-06 06:29:35 -08:00
firmware READMEs, images, travis stub 2019-02-10 07:07:27 -08:00
hardware import PCB design 2019-02-10 06:47:56 -08:00
images Windows icon 2019-03-03 13:26:42 -08:00
nsis Adds to PATH on install, removes on uninstall 2020-01-26 11:54:37 -08:00
python Fix link 2023-02-07 15:00:50 -08:00
.gitignore Skeleton of C library 2019-02-23 10:22:33 -08:00
.readthedocs.yml Generate all formats 2021-02-10 17:18:50 -08:00
.travis.yml READMEs, images, travis stub 2019-02-10 07:07:27 -08:00
LICENSE NSIS install script, win32 port enumeration in GUI 2019-03-03 15:43:52 -08:00
README.md Readthedocs badge 2021-02-12 06:27:16 -08:00
testall Fix cast for clang/clang++ in -c++17 mode, using a C-style cast so it's buildable by plain C users. 2020-03-06 06:20:38 -08:00

README.md

logo

Build Status Documentation Status

I2CDriver is a tool for controlling any I2C device from your PC's USB port, and can also monitor and capture I2C traffic. It connects as a standard USB serial device, so there are no drivers to install. On the main site i2cdriver.com, there are drivers for

  • Windows/Mac/Linux GUI
  • Windows/Mac/Linux command-line
  • Python 2 and 3
  • Windows/Mac/Linux C/C++

front

Full documentation is at i2cdriver.com.

For developers: How to make a release

To release Python:

rm -rf dist/*
python setup.py sdist
twine upload dist/*

To build the Windows installer, you first need to build the two executables i2ccl.exe and i2cgui.exe then use an NSIS script to create the installer.

On Linux cross-compile i2ccl:

cd c
make -f win32/Makefile

On Windows first make sure that you can run the GUI on the command-line, e.g.

python python\samples\i2cgui.py

(You may need to install i2cdriver, wxPython and pySerial).

Then build the GUI executable using pyinstaller:

cd python\samples
pyinstaller --onefile --windowed --icon=../../images/i2cdriver.ico i2cgui.py

This builds the executable in python\samples\dist\i2cgui.exe.

The Windows installer is built with NSIS (Nullsoft Scriptable Install System). Download and install it.

Copy the two executables i2ccl.exe and i2cgui.exe into nsis/.

Then build the installer with NSIS:

cd nsis
"C:\Program Files\NSIS\makensis.exe" i2cdriver.nsi

The script go.bat in nsis has an example complete flow.