setup for PyPI

Author: 2718281828459045235360287471352

pypi/.gitignore

@@ -0,0 +1,6 @@
+__pycache__
+*~
+.*~
+build/
+dist/
+pyuart.egg-info/

pypi/Makefile

@@ -0,0 +1,13 @@
+#Time-stamp: <2023-06-05 17:00:34 hamada>
+
+wheel:
+	python3 setup.py bdist_wheel
+
+
+clean:
+	rm -rf build pyuart.egg-info dist
+
+test.upload:
+	twine upload --repository testpypi dist/*
+
+

pypi/README.md

@@ -0,0 +1,177 @@
+# pyuart
+
+## 概要
+
+UARTデバッグをpythonスクリプトで行うためのモジュールです。これまで
+Tera-termやArduino IDEコンソールなどでライトウェイトにUARTデバッグをし
+ていた人が、リモートデバッグ環境を構築したり、並列UART高負荷耐久テスト
+等々、もう少し突っ込んだUARTデバッグをしたい時に効果を発揮するはずです。
+
+## 動作環境
+
+動作確認済みの実機環境
+- Python 3.10.6
+- PC
+  - CPU: Intel Core i7-12700
+  - OS: Ubuntu 22.04.2 LTS
+- Raspberry Pi 4 Model B Rev 1.5
+  - CPU: BCM2835
+  - OS: Ubuntu 22.04.2 LTS
+- USB-TTL converter
+  - QinHeng Electronics CH340 serial converter
+  - Future Technology Devices International, Ltd FT232 Serial (UART) IC
+
+## 前提
+
+```1 Byte == 1 Octet == 8 bit```
+
+## Installation
+
+```
+make setup
+make chmod
+```
+
+OSS公開後には以下のインストール方法が使える予定
+```
+pip install pyuart
+```
+
+```make chmod```は環境依存です。/dev/serial/* やlsusbなど駆使してUSB-TTL converterデバイスを探しましょう。 
+詳細はMakefileを読むと理解の助けになるでしょう。
+
+
+## サンプル
+
+```aelib/uart```モジュールの操作方法のサンプルコードを以下にメモしておきます。
+このサンプルを見るだけで動かすことができるはずですが、詳細な説明は後日記載する予定です。
+
+
+### 例1: 1 octetづつTx(送信)したい場合
+
+```:test_tx.py
+from aelib import uart
+
+u0 = uart.uart(dev='/dev/ttyUSB0', baudrate = 115200, timeout = 15)
+u0.open()
+
+u0.tx(1)
+u0.tx(2)
+u0.tx(77)
+
+u0.close()
+
+```
+
+### 例2: 1 octetづつRx(受信)したい場合
+
+```:test_rx.py
+from aelib import uart
+
+u0 = uart.uart(dev='/dev/ttyS0', baudrate = 115200, timeout = 240)
+u0.open()
+
+for data in u0.rx():
+    print (data)
+
+u0.close()
+
+```
+
+※: rx()メソッドはジェネレータです。
+
+### 例3: ファイルをTx(送信)したい場合
+
+```:sample.tx.file.py
+from aelib import uart
+
+u0 = uart.uart(dev='/dev/ttyUSB0', baudrate = 115200, timeout = 15)
+u0.open()
+
+u0.tx_file(filename = '/tmp/file.bin')
+
+u0.close()
+
+```
+
+### 例4: ファイルをRx(受信)したい場合
+
+```sample.rx.file.py
+from aelib import uart
+
+u0 = uart.uart(dev='/dev/ttyUSB0', baudrate = 115200, timeout = 15)
+u0.open()
+
+u0.rx_file(filename = './recv.bin', n_byte = 1048576)
+
+u0.close()
+
+```
+
+**ファイルRxでの注意事項**
+
+UARTを使ったデータ通信では受け取るファイルのサイズは上位プロトコル層で定義しておかなければファイルサイズを事前に知ることができません。
+そのため上位プロトコルを定義していない本モジュールでは、ファイルのRx(受信)実行時に受信ファイルサイズをn_byteで指定する必要があります。
+上記のサンプル例では ```n_byte = 1048576```を指定しています。これは1MB(1048576 Byte)のファイルを受信することを指定しています。
+
+(なお、この文章では```1 octet = 1 byte```を仮定しています)
+
+
+
+### 例5: 並列Txの実行 (MPI利用)
+
+```mpi.tx.py
+#!/usr/bin/env python3
+from mpi4py import MPI
+from aelib import uart
+
+comm = MPI.COMM_WORLD
+proc_id = comm.Get_rank()
+nproc = comm.Get_size()
+hostname = MPI.Get_processor_name()
+
+devfile = "/dev/ttyUSB%d" % proc_id
+print(devfile, flush=True)
+
+u0 = uart.uart(dev=devfile, baudrate = 115200, timeout = 15)
+u0.open()
+u0.tx(123)
+
+u0.close()
+
+```
+
+並列実行は```make mpirun```や以下のようにmpirunコマンドを使います。
+```
+ mpirun -np 4 --oversubscribe mpi.tx.py
+```
+
+
+
+
+## 注意
+
+Ubuntu 22ではCH341チップを使ったUSB-serialコンバーターはそのままでは動きません。
+```
+sudo apt remove brltty
+```
+にてbrlttyを削除してから使用しましょう。
+
+
+[参考|https://stackoverflow.com/questions/70123431/why-would-ch341-uart-is-disconnected-from-ttyusb]
+
+```
+For Ubuntu 22.04 the simplest solution is to remove the package brltty
+via sudo apt remove brltty, since its unnecessary unless you're using
+a braille e-reader, however unsure if it could cause errors later on.
+```
+
+## 参考
+
+### ubuntu22 PCでの/dev/serialの一例
+
+```
+arkedge@ci01:~/git/pyuart$ ls -l /dev/serial/by-id/usb-1a86_USB_Serial-if00-port0
+lrwxrwxrwx 1 root root 13  4月 30 14:58 /dev/serial/by-id/usb-1a86_USB_Serial-if00-port0 -> ../../ttyUSB0
+```
+

pypi/pyuart/uart.py

@@ -0,0 +1,182 @@
+#!/usr/bin/env python3
+
+__author__ = "ArkEdge Space Inc."
+
+import struct
+import serial
+import time
+import math
+import binascii
+import pprint
+
+
+def get_baudrate_list():
+    return [1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400, 460800, 500000, 576000, 921600, 1000000, 11520000, 1500000, 20000]
+
+
+def byte2int(i_byte, i_endian = 'big'):
+    return int.from_bytes(i_byte, i_endian)
+
+def int2byte(i_int, i_endian = 'big'):
+    n_octet = math.ceil(math.log2(i_int)/8.0)
+    print ("n_octet: %d" % n_octet)
+    return i_int.to_bytes(n_octet, i_endian)
+
+'''
+array conversion: int -> byte
+    array is list in python
+'''
+def convArrayInt2Byte(array_int):
+    array_byte = []
+    for data_i in array_int:
+        array_byte.append(bytes([0xff & data_i]))
+    return array_byte
+
+'''
+array conversion: byte -> int
+    array is list in python
+'''
+def convArrayByte2Int(array_byte):
+    array_int = []
+    for _b in array_byte:
+        _x = struct.unpack('1B', _b)
+        array_int.append(_x[0])
+    return array_int
+
+def readFileBin(filename = '__dump__.img'):
+    with open(filename, mode='rb') as f:
+        _content = f.read() # list of Integers, not Bytes !
+    print ('file: %s, size: %d-bytes' % (filename, len(_content)))
+
+    # conversion: int -> byte
+    _array_bytes = []
+    for _ci in _content:
+        _array_bytes.append(bytes([_ci]))
+
+    return _array_bytes
+
+def writeFileBin(filename = 'tmp.img', data = []):
+    with open(filename, mode='wb') as f:
+        for cb in data:
+            f.write(cb)
+
+byte_order = 'big'
+
+uart_settings = {
+    'dev': '/dev/ttyUSB0',
+    'baudrate': 115200, #9600, # 9600, 115200
+    'timeout': 10,
+    }
+
+class uart:
+
+    def __init__(self, dev=uart_settings['dev'], baudrate=uart_settings['baudrate'], timeout=uart_settings['timeout'], byte_order=byte_order):
+        self.dev = dev
+        self.baudrate = baudrate
+        self.timeout = timeout
+        self.byte_order = byte_order
+
+    def open(self):
+        self.uart_device = serial.Serial(self.dev, self.baudrate, timeout=self.timeout)
+
+    def close(self):
+        self.uart_device.close()
+
+    '''
+    tx: transfer 1 octet
+    '''
+    def tx(self, x_int):
+        _x_byte = bytes([0xFF & x_int])
+        return self.uart_device.write(_x_byte)
+
+
+    '''
+    rx_primitive: receive 1 octet
+    '''
+    def rx_primitive(self):
+
+        rx_byte = self.uart_device.read(1)
+
+        ret = {
+            'byte': rx_byte,
+            'int': 0,
+            'isValid': False,
+        }
+
+        if len(rx_byte) > 0:
+            rx_int = struct.unpack('1B', rx_byte)[0]
+            ret = {
+                'byte': rx_byte,
+                'int': rx_int,
+                'is_valid': True,
+            }
+
+        return ret
+
+    '''
+    rx: receive N octets forerver
+    '''
+    def rx(self):
+
+        while True:
+            rx_data = self.rx_primitive()
+            if True == rx_data['is_valid']:
+                yield rx_data['int']
+
+    def __testTx(self, data=0x6162636465666768696a6b6c6d6e6f707172737475767778797a):
+        _eot = 0x04
+        data = data << 16 | 0x0D0A # <CR><LF>
+        data = 0x6465
+        data_byte = int2byte(data, byte_order)
+        self.uart_device.write(data_byte)
+        if False:
+            print("0x%x" % byte2int(data_byte, byte_order))
+            time.sleep(1.0)
+
+    def tx_file(self, filename = '/tmp/tran.img'):
+        data_tx = readFileBin(filename = filename)
+
+        n_byte = len(data_tx)
+        progress_tick = int(math.ceil(n_byte / 20.0))
+
+        t0 = time.time()
+        for i, _b in enumerate(data_tx):
+            self.uart_device.write(_b)
+            if 0 == (i % progress_tick):
+                print('=>', end='', flush=True)
+        t = time.time() - t0
+        bw = n_byte/t
+        print("")
+        print(": End UART-Tx")
+        print("--------------------------------")
+        print("BandWidth: %f KByte/sec" % (bw/1024.))
+        print("--------------------------------")
+        return {
+            'n_byte': n_byte,
+            'wallclocktime': t,
+            'bandwidth': bw,
+            }
+
+
+    def rx_file(self, filename = '/tmp/recv.img', n_byte = 1048576):
+        progress_tick = int(math.ceil(n_byte / 20.0))
+        data_rx = []
+        data_rx_byte = []
+        for i in range(n_byte):
+            rx_byte = self.uart_device.read(1)
+            rx_int = struct.unpack('1B', rx_byte)[0]
+            data_rx.append(rx_int)
+            data_rx_byte.append(rx_byte)
+
+            if 0 == i % progress_tick:
+                print ('=>', end = '', flush = True)
+
+        writeFileBin(filename = filename, data = data_rx_byte)
+
+        print("\n: End UART-Rx")
+
+
+
+    def diag(self):
+        pprint.pprint(vars(self))
+        return vars(self)

pypi/setup.py

@@ -0,0 +1,35 @@
+from setuptools import setup
+from codecs import open
+from os import path
+
+here = path.abspath(path.dirname(__file__))
+
+
+with open(path.join(here, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
+setup(
+    name='pyuart', # パッケージ名(プロジェクト名)
+    packages=['pyuart'], # パッケージ内(プロジェクト内)のパッケージ名をリスト形式で指定
+
+    version='0.0.1', # バージョン
+
+    license='MIT', # ライセンス
+
+    install_requires=['pyserial'], # pip installする際に同時にインストールされるパッケージ名をリスト形式で指定
+
+    author='Tsuyoshi Hamada', # パッケージ作者の名前
+    author_email='hamada@arkedgespace.com', # パッケージ作者の連絡先メールアドレス
+
+    url='https://github.com/arkedge/pyuart', # パッケージに関連するサイトのURL(GitHubなど)
+
+    description='a simple UART library for python3', # パッケージの簡単な説明
+    long_description='pyuart', # PyPIに'Project description'として表示されるパッケージの説明文
+    long_description_content_type='text/markdown', # long_descriptionの形式を'text/plain', 'text/x-rst', 'text/markdown'のいずれかから指定
+    keywords='pyuart uart', # PyPIでの検索用キーワードをスペース区切りで指定
+
+    classifiers=[
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python :: 3.10',
+    ], # パッケージ(プロジェクト)の分類。https://pypi.org/classifiers/に掲載されているものを指定可能。
+)