Skip to content

Commit 7b4e58e

Browse files
committed
update README.md
1 parent 33367ac commit 7b4e58e

File tree

2 files changed

+22
-23
lines changed

2 files changed

+22
-23
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
1-
# Python Library for reTerminal
1+
# Python library for Seeed RPi board
22

3-
This is a Python library which enables you to use the onboard hardware on the [reTerminal](https://www.seeedstudio.com/ReTerminal-with-CM4-p-4904.html) and [reTerminal Bridge](https://wiki.seeedstudio.com/reTerminalBridge/). Currently the **accelerometer, user LEDs, user buttons and buzzer** can be accessed using this Python library on reTerminal, and the **fan, RS232, RS485, CAN** can be accessed by using this Python library on reTerminal Bridge.
3+
This is a Python library specifically designed for Seeed's RPi boards, enabling you to utilize the onboard hardware features. Currently, the accelerometer, user LEDs, user buttons, and buzzer can be accessed and controlled using this library on Seeed's RPi boards. Additionally, if your board supports features like a fan, RS232, RS485, or CAN, this library provides the necessary interfaces to interact with them as well.
44

55
## Installation
66

77
### From PyPI
88

99
- To install the latest release from PyPI
1010
```
11-
sudo pip3 install seeed-python-reterminal
11+
sudo pip3 install seeed-python-rpi
1212
```
1313

1414
### From Source
1515

1616
- To install from source, clone this repository
1717
```
18-
git clone https://github.com/Seeed-Studio/Seeed_Python_ReTerminal
18+
git clone https://github.com/Seeed-Studio/Seeed_Python_RPi
1919
```
2020

2121
- Install the library
2222

2323
```
24-
cd Seeed_Python_ReTerminal
24+
cd Seeed_Python_rpi
2525
sudo pip3 install .
2626
```
2727

@@ -30,7 +30,7 @@ sudo pip3 install .
3030
### User LEDs Test
3131

3232
```python
33-
import seeed_python_reterminal.core as rt
33+
import seeed_python_rpi.core as rt
3434
import time
3535

3636
print("STA ON, USR OFF")
@@ -57,7 +57,7 @@ rt.usr_led = False
5757
### Buzzer Test
5858

5959
```python
60-
import seeed_python_reterminal.core as rt
60+
import seeed_python_rpi.core as rt
6161
import time
6262

6363
print("BUZZER ON")
@@ -71,8 +71,8 @@ rt.buzzer = False
7171
### User Buttons Test
7272

7373
```python
74-
import seeed_python_reterminal.core as rt
75-
import seeed_python_reterminal.button as rt_btn
74+
import seeed_python_rpi.core as rt
75+
import seeed_python_rpi.button as rt_btn
7676

7777

7878
device = rt.get_button_device()
@@ -86,8 +86,8 @@ while True:
8686
### Accelerometer Test
8787

8888
```python
89-
import seeed_python_reterminal.core as rt
90-
import seeed_python_reterminal.acceleration as rt_accel
89+
import seeed_python_rpi.core as rt
90+
import seeed_python_rpi.acceleration as rt_accel
9191

9292

9393
device = rt.get_acceleration_device()
@@ -102,9 +102,9 @@ while True:
102102

103103
```python
104104
import asyncio
105-
import seeed_python_reterminal.core as rt
106-
import seeed_python_reterminal.acceleration as rt_accel
107-
import seeed_python_reterminal.button as rt_btn
105+
import seeed_python_rpi.core as rt
106+
import seeed_python_rpi.acceleration as rt_accel
107+
import seeed_python_rpi.button as rt_btn
108108

109109

110110
async def accel_coroutine(device):
@@ -134,7 +134,7 @@ loop.run_forever()
134134
### Illuminance Sensor Test
135135
```python
136136
import time
137-
import seeed_python_reterminal.core as rt
137+
import seeed_python_rpi.core as rt
138138

139139
while True:
140140
print(rt.illuminance)
@@ -146,7 +146,7 @@ while True:
146146
### fan Test
147147

148148
```python
149-
import seeed_python_reterminal.core as rt
149+
import seeed_python_rpi.core as rt
150150
import time
151151

152152
print("FAN ON")
@@ -163,7 +163,7 @@ rt.fan = False
163163
import sys
164164
import serial
165165
import time
166-
import seeed_python_reterminal.core as rt
166+
import seeed_python_rpi.core as rt
167167

168168
param1 = sys.argv[1]
169169

@@ -217,7 +217,7 @@ python3 test_rs232.py receive # test the receive(RX) function of RS232
217217
import sys
218218
import serial
219219
import time
220-
import seeed_python_reterminal.core as rt
220+
import seeed_python_rpi.core as rt
221221

222222
param1 = sys.argv[1]
223223

setup.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,20 @@
44
long_description = f.read()
55

66
setup(
7-
name='seeed-python-reterminal',
8-
version='0.5',
9-
description='seeed-python-reterminal',
7+
name='seeed-python-rpi',
8+
version='0.6',
9+
description='seeed-python-rpi',
1010
long_description=long_description,
1111
long_description_content_type='text/markdown',
1212
license='MIT License',
13-
url='https://github.com/Seeed-Studio/Seeed_Python_ReTerminal',
13+
url='https://github.com/Seeed-Studio/Seeed_Python_RPi',
1414
author='Takashi Matsuoka (matsujirushi)',
1515
author_email='matsujirushi@live.jp',
1616
classifiers=[
1717
"Programming Language :: Python :: 3.8",
1818
],
1919
install_requires=[
2020
"evdev",
21-
"RPi.GPIO",
2221
],
2322
packages=find_packages(
2423
exclude=[

0 commit comments

Comments
 (0)