MeTIOT 0.1.5

Communication handling for all MeT IOT devices

MeT IOT Communication

Useful Links

• API Reference
• Python Library Guide
• Example Projects

Changelog v0.1.5

• Added error code communication to asynchronous function handlers
• Exposed AsyncErrorCode enum
• Created safeguard to stop users from creating multiple listen threads
• Fixed occurances of the Controller being unable to determine in a timely manner if the socket is dead
• Fixed error in example python code
• Changed FISH_TANK to TANK_GUARDIAN (among other variants) for better consistency/translation to actual device name

Known issues

• Exit Signal (SIGABRT/SIGSEGV): Upon exiting the Python interpreter, a free(): invalid pointer error may occur.
  • Reason: This is a known teardown conflict between the Python Garbage Collector and the C++ Runtime (libstdc++). It occurs after all user code has executed.
  • Impact: None. This does not affect data transmission or device logic during the program's lifecycle.

How To Use

Importing the Library

Use pip to install the library

pip install MeTIOT

[!NOTE] This library is not pre-compiled. You must have installed on your system (Other version may work but are official unsupported):

• GCC >= 15.2.1
• CMake >= 3.10

Programming with the Library

Testing the library imported successfully

You can use this code to test you can successfully import the library into your code.

import MeTIOT

client = MeTIOT.DeviceClient("0.0.0.0", 12345)

print(type(client))
print("MeTIOT import successful!")

Using the library

For further information on how to use this library refer to the PYTHON_LIB_GUIDE.md document.

How to compile and use from this repository

Linux based systems:

1. Clone the repository

git clone https://github.com/Microelectronic-Technologies/MeTIOTCommunication.git

2. Navigate into repository

cd MeTIOTCommunication/

3. Create and navigate into build directory

mkdir build
cd build

4. Compile library using CMake

cmake ..
cmake --build . --config Release

5. Export path to python

export PYTHONPATH=./src/python_bindings:$PYTHONPATH

6. Now you can use and import the library in your current directory
7. (optional) Test the library is python

python3

import MeTIOT
client = MeTIOT.DeviceClient("0.0.0.0", 12345)
type(client)