sakuraio/python-sakuraio

A python library for Sakura Communication Module

Python library for SakuraIO

WARNING: This library is under development with destructive changes.

Overview

This library contains two functions. One is to connect to Sakura Communication Modules (for Hardware). Another one is to connect to Platform API in https://api.sakura.io/ (for Service).

Documentation

For API documentation, usage and examples see files in the "./doc" directory. The ".rst" files can be read in any text editor or being converted to HTML or PDF using Sphinx. An HTML version is online at

http://python-sakuraio.readthedocs.io/

For Hardware

It currently tested with Raspberry Pi only.

Requirements

Python2

• Python = 2.7
• python-smbus (for I2C)
• python-rpi.gpio (for GPIO on Raspberry Pi)
• python-serial (for Serial)

Python3

• Python >= 3.4
• python3-smbus (for I2C)
• python3-rpi.gpio (for GPIO on Raspberry Pi)
• python3-serial (for Serial)

Install

If you want to use python3 it may be required replace pip to pip3.

# From PyPi
sudo pip install sakuraio
# From Github.com
sudo pip install -e git+https://github.com/sakuraio/python-sakuraio.git#egg=sakuraio

Example

I2C (SMBus)

from sakuraio.hardware.rpi import SakuraIOSMBus

sakuraio = SakuraIOSMBus()
print(sakuraio.get_unique_id())

NOTE

Some linux kernel version of raspbian are not supported.

Please see the document of this HAT.

DO NOT update kernel by rpi-update, it is reported that OSError: [Errno 121] Remote I/O error occurs with unofficial build version.

SPI (GPIO)

from sakuraio.hardware.rpi import SakuraIOGPIO

sakuraio = SakuraIOGPIO()
print(sakuraio.get_unique_id())

Serial (UART)

from sakuraio.hardware.rpi import SakuraIOSerial

sakuraio = SakuraIOSerial("/dev/ttyS0")
print(sakuraio.get_unique_id())

NOTE

Disable serial console by using raspi-config.

output

16X0000001

python-sakuraio's Issues

Add python-sakuraio documents for software

Summary

• Add documents for software in http://python-sakuraio.readthedocs.io/en/latest/

Current

• only for hardware document.

tasks

• add README.md in this repository
• add detail document http://python-sakuraio.readthedocs.io/en/latest/

Documents for file downloads

should add documents by #20

get_firmware_update_status

データシートによると
0x80はアップデート試行中を示し
0x40はエラーフラグとのことなので

 "inprogress": (response & 0x80) == 0x80,
 "has_error": (response & 0x40) == 0x40,
 "status": response & 0x3f,

とした方が良いのかもしれません。

ハードウェアリセット直後に OSError: [Errno 121] Remote I/O error

ハードウェアリセット直後にget_is_online()を呼ぶと、I2Cの準備が完了していないのか、Remote I/O errorになります。
sakura.ioモジュールのI2Cがreadyかどうかの判断はどのようにすべきでしょうか？

$ echo 22 > /sys/class/gpio/export; \
echo out > /sys/class/gpio/gpio22/direction; \
echo 1 > /sys/class/gpio/gpio22/value; sleep 0.1; \
echo 0 > /sys/class/gpio/gpio22/value; \
python3 -c "from sakuraio.hardware.rpi import SakuraIOSMBus;print(SakuraIOSMBus().get_is_online())"
-bash: echo: write error: Device or resource busy
Traceback (most recent call last):
  File "<string>", line 1, in <module>
  File "/usr/local/lib/python3.5/dist-packages/sakuraio/hardware/commands/common.py", line 34, in get_is_online
    status = self.get_connection_status()
  File "/usr/local/lib/python3.5/dist-packages/sakuraio/hardware/commands/common.py", line 24, in get_connection_status
    response = self.execute_command(CMD_GET_CONNECTION_STATUS)
  File "/usr/local/lib/python3.5/dist-packages/sakuraio/hardware/base.py", line 44, in execute_command
    self.start(False)
  File "/usr/local/lib/python3.5/dist-packages/sakuraio/hardware/rpi/__init__.py", line 16, in start
    self.bus.write_i2c_block_data(SAKURAIO_SLAVE_ADDR, self.request[0], self.request[1:])
OSError: [Errno 121] Remote I/O error

とりあえず、ハードウェアリセットからI2Cアクセスまで2秒くらい待機することで回避しています。

Exception handling in examples

code execution backdoor

We discovered a malicious backdoor in the project's dependencies, present in the /requirements.txt file. Its malicious backdoor is the request package. Even if the request has been deleted by PyPI, many mirror sites have not completely deleted this package, so it can still be installed. Using pip install request -i http://pypi.doubanio.com/simple --trusted-host pypi.doubanio.com, the request malicious plugin can be successfully installed.

Suggestion: remove malicious dependency plugin request in /requirements.txt