معرفی شرکت ها
arizon-usb-apiserver-0.4.6
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Driver for Arizona USB Pressure Sensor
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | arizon-usb-apiserver-0.4.6 |
| نام | arizon-usb-apiserver |
| نسخه کتابخانه | 0.4.6 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | davidliyutong |
| ایمیل نویسنده | davidliyutong@sjtu.edu.cn |
| آدرس صفحه اصلی | - |
| آدرس اینترنتی | https://pypi.org/project/arizon-usb-apiserver/ |
| مجوز | - |
# ARIZON USB APIServer
[](https://pypi.org/project/arizon_usb_apiserver/)
An APIServer for ARIZON USB force sensors.
## Installation
Clone & `cd` into this repository then:
```shell
python setup.py install
```
Or download from PyPI:
```shell
python -m pip install arizon-usb-apiserver
```
## Get Started
The apiserver operates in two modes: RESTful and gRPC. They share the same configuration schema.
### Basics
To read the sensor locally, use this snippet:
```python
from serial import Serial
from arizon_usb_apiserver import Sensor
if __name__ == '__main__':
conn = Serial("COM16", 115200)
sensor = Sensor(conn)
sensor.reset()
while True:
print(sensor.read_once())
```
To generate configuration from command line interaction run:
```shell
python -m arizon_usb_apiserver configure
```
### RESTful
To launch the apiserver in RESTful mode, set the `API_SERVER_RESTFUL` to `1` before run apiserver command:
```shell
export API_SERVER_RESTFUL=1
```
Or run with variable
```shell
API_SERVER_RESTFUL=1 python -m arizon_usb_apiserver apiserver
```
> Powershell: `Set-Item -Path Env:API_SERVER_RESTFUL -Value 1`
Or you can directely run `apiserver.restful`
```shell
python -m arizon_usb_apiserver apiserver.restful
```
Here are some examples to test the apiserver using curl
- Init sensor
```shell
curl -X 'PUT' \
'http://127.0.0.1:8080/v1/arizon/force?flag=true' \
-H 'accept: application/json'
```
- Read sensor
```shell
curl -X 'GET' \
'http://127.0.0.1:8080/v1/arizon/force' \
-H 'accept: application/json'
```
- Shutdown sensor
```shell
curl -X 'PUT' \
'http://127.0.0.1:8080/v1/arizon/force?flag=false' \
-H 'accept: application/json'
```
## gRPC
Run this command
```shell
python -m arizon_usb_apiserver apiserver
```
Or you can directely run `apiserver.grpc`
```shell
python -m arizon_usb_apiserver apiserver.grpc
```
## Testing with cli tools
To test RESTful API, run:
```shell
python -m arizon_usb_apiserver test.restful
```
You will be asked to input API endpoint.
To test gRPC API, run:
```shell
python -m arizon_usb_apiserver test.grpc
```
You will be asked to input API endpoint.
## Generate Client
### Restful
First launch the apiserver, then run `openapi-python-client`:
```shell
openapi-python-client generate --url http://127.0.0.1:8080/openapi.json
rm -rf ./arizon_usb_driver/client/restful
mv fast-api-client/fast_api_client ./arizon_usb_driver/client/restful
rm -rf ./fast-api-client
```
### GRPC
First `cd arizon_usb_apiserver/grpc`, then run:
```shell
python -m grpc_tools.protoc -I../../manifests/protos --python_out=. --pyi_out=. --grpc_python_out=. ../../manifests/protos/force_packet.proto
```
You might need to replace `import force_packet_pb2 as force__packet__pb2` with `import arizon_usb_apiserver.grpc.force_packet_pb2 as force__packet__pb2`
## Serial Protocol
| Field | Content |
| ------------ | ------- |
| Head | 0xFE |
| Status | 1 Byte |
| Data | 3 Byte |
| XOR checksum | 1 Byte |
- Status: 4 bits of address + 4 bits represents number of digits
- Data: 3 bytes of signed integers, no digit, big-endian.
- Checksum: xor() of first 5 bytes
## Configuration
Here is an template of configuration
```yaml
arizon_usb_apiserver: # Key
api: # Control API settings
interface: 0.0.0.0 # Listen interface
port: 8080 # Listen port
debug: false # Enable debug
serials: # Serial connections, can be a list
- baudrate: 115200 # Baudrate, default is 115200, no need to change
port: COM8 # Port name
addr: "dev1" # Friendly name
data_path: ./arizon_data # Path to save data
```
نیازمندی
| مقدار | نام |
|---|---|
| - | pyserial |
| - | numpy |
| >=0.87.0 | fastapi |
| >=0.20.0 | uvicorn |
| - | pyyaml |
| - | py-cli-interaction |
| - | httpx |
| - | attr |
| - | grpcio |
| - | grpcio-tools |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.7 | Python |
نحوه نصب
نصب پکیج whl arizon-usb-apiserver-0.4.6:
pip install arizon-usb-apiserver-0.4.6.whl
نصب پکیج tar.gz arizon-usb-apiserver-0.4.6:
pip install arizon-usb-apiserver-0.4.6.tar.gz