Metadata-Version: 2.1
Name: mport
Version: 0.1.1
Summary: IO port based on mmap
Home-page: https://github.com/wenyang1983/mport
Author: Wenyang Duan
Author-email: wenyang.duan@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# mport
IO port based on shared memory map (mmap).

## install
```
pip install mport
```

## Usage
* Prototype protocols
* Build control layer and/or data collection layer for AI training applications
* Broadcast operations to multiple receiving applications
* Hardware simulation where you have virtual devices running as separate processes yet communicate via ports

Example Reader
```
import mport

speed_port = mport.Port('io.dat')
light_port = mport.Port('io.dat', offset=2)

while True:
  car.set_speed(speed_port.value)
  car.light(light_port.value)
```

Example speed controller
```
import mport

speed_port = mport.Port('io.dat')

speed_port.value = 42
```

Example light controller
```
import mport

light_port = mport.Port('io.dat', offset=2)
light_port.value = True
```

RGB LED Example
```
python3 -m mport.examples.rgb_led
python3 -m mport.exmaples.rgb_led_drive
```


