You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
jean 6235c58a3f
plotly 3.10
1 month ago
OpenEIT Add --debug-dash flag. 6 months ago
images better formatted on switch picture 1 month ago
sandbox RX/TX state handling 11 months ago
static basic tab structure working, with all data available, not finished yet 1 year ago
.gitignore functional real-time dashboard and reconstruction 2 years ago
LICENSE.txt added header 10 months ago
README.md fix missing word in readme 1 month ago
app.py Add --debug-dash flag. 6 months ago
image.py plotlyified 1 year ago
offline.py added header 10 months ago
requirements.txt plotly 3.10 1 month ago
setup.py latest dash library version 6 months ago
simdata.py fixed baselining 1 year ago
simdata.txt plotlyified 1 year ago
uart_service.py RX/TX state handling 11 months ago

README.md

OpenEIT Dashboard

Biomedical Imaging has previously been expensive and near impossible to hack and experiment with. If more people experimented and understood how imaging works we could move it forward much faster and make these transformative technologies available to everyone. OpenEIT(EIT is for electrical impedance tomography) uses non-ionizing AC current to recreate an image of any conductive material, such as your lungs, arm or head, using the same tomographic reconstruction technique as a CATSCAN. The PCB is only 2” square, with bluetooth, making it a portable and hackable way to do biomedical imaging!

NOTE FOR WINDOWS USERS

SPECTRA uses an FTDI chip to communicate via UART. The VCP FTDI driver is not pre-installed on Windows(but is on all other OS’s). If you are running a Windows machine you should follow these instructions to install the FTDI driver before continuing to the dashboard install: https://www.ftdichip.com/Drivers/VCP.htm

How to install the python dashboard.

Requirements

Python 3.6.7+

Install

pip install -r requirements.txt

If you have any problems, it’s likely that the requirements installation didn’t complete, and you have incorrect versions of the modules installed. The following command will check the version of a single module, and you should check each module to ensure it is the same as listed in the requirements.txt file.

pip show <package_name>

Alternatively you can run the following command to get a list of all installed modules. Before creating an issue in this repository regarding the installation process, check each version in the requirements.txt against your installed version. They should match!

pip freeze

Make sure the button is in the ‘ON’ position.

Plug in your microUSB cable if using with serial, then make sure that switch is turned on. Bluetooth and serial comms should now be active.

Run

python app.py

You should now see the server running through the console at a server location accessible by any internet browser at Running on http://127.0.0.1:8050/. To see the dashboard open a browser window(I use chrome) to this address.

The dashboard should now be open and running and look like this:

Functionality

The dashboard can connect to the SPECTRA device via Bluetooth or Serial connection, do tomographic reconstructions in real-time, or by reading in offline data. You can also record data for later analysis. We suggest you have a look in the tutorials to try time series, bioimpedance spectroscopy and electrical impedance tomography functionality. Tutorials

In the root OpenEIT folder there are a couple of extra scripts which are helpful when doing analysis.

offline.py

Is an example of how to read in offline data for analysis outside the dashboard.

simdata.py

Simdata creates data in the same format as the hardware device, incase you want to do simulations before collecting real data.

You can also use the main software to do either time series or bioimpedance spectroscopy. Instructions for these can be found in the readthedocs tutorials.

Algorithms

There are three classic EIT algorithms implemented - Back Projection, Graz Consensus and Gauss Newton Methods using the pyEIT toolbox - pyEIT. Each has many parameters which can be adjusted to get better results. It’s also possible to create 3D meshes with this software in a similar manner to EIDORS(a matlab based EIT software suite).

License

The Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License seems to fit best with this project. Basically your’e liable to keep any derivative works open, and if you want to do a private fork for a commercial application please contact us and pay a small fee(which goes towards the open source project next revision) either in cash or equity in your company. Check out the human readable summary here:

Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

If you’d like to make a derivative of this project in a commercial setting, we’d love a payment in exchange for a commercial license so that we can afford to spend time both maintaining this project and making more projects like this one. If this hybrid open source model works, it would enable open source projects to receive some funding, making the global commons stronger to benefit everyone.

Are you using this effort? Is it helpful to you? Would you like to see it maintained, updated and perhaps a new iteration come out sometime? This project has taken a lot of time and effort! The best way to keep it going is to donate.