Skip to content

Commit

Permalink
Merge pull request #5 from mcci-catena/issue4
Browse files Browse the repository at this point in the history
Fix #4: Merge release for v.1.0.3.10
  • Loading branch information
terrillmoore authored Jan 23, 2021
2 parents b54e553 + 2430388 commit 334558d
Showing 1 changed file with 34 additions and 22 deletions.
56 changes: 34 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# rwc-python-api

This is python library to control RWC5020x LoRa Tester remotely through either serial
(RS232) or ethernet port.
This is a Python library to control the RWC5020x LoRa Tester remotely through either the serial port
(RS232) or the Ethernet port.

## Requirements

Expand All @@ -16,37 +16,49 @@ This is python library to control RWC5020x LoRa Tester remotely through either s

## How to install the package

1. clone the repository from [github](https://github.com/mcci-catena/rwc-python-api)
2. Open terminal in PC
3. Go to /[path_to_repository]/rwc-python-api/
4. To install, enter the command `python setup.py install`
1. Clone the repository from [github](https://github.com/mcci-catena/rwc-python-api)
2. Open a terminal window and change directory to `{path_to_repository}/rwc-python-api`.
3. To install the library in your local Python setup, enter the command

```bash
python setup.py install
```

## How to use the package

Create a python file and import the class library from package:
Create a Python file and import the class library from package:

from rwclib.cRWC5020x import RWCTesterApi
```python
from rwclib.cRWC5020x import RWCTesterApi
```

Create a class object and pass serial port or ethernet port & ip address as constructor parameter

#Serial Communication
ob = RWCTesterApi('COM5') #windows
(or)
ob = RWCTesterApi('/dev/ttyUSB0') #Linux
(or)
#Ethernet Communication
ob = RWCTesterApi('5001', '192.168.0.33')
```python
# ---Serial Communication---
rwc = RWCTesterApi('COM5') #windows
(or)
rwc = RWCTesterApi('/dev/ttyUSB0') #Linux
# ---Ethernet Communication---
rwc = RWCTesterApi('5001', '192.168.0.33')
```

Access the class methods using instantiated object

ob.query_identification()
To know more about class methods, please see the **code documentation** in the following location in cloned repository:
```python
rwc.query_identification()
```

*/[path_to_repository]/rwc-python-api/doc/build/html/index.html*
To know more about class methods, please see the **code documentation** in the following location in this repository: [`./doc/build/html/index.html`](doc/build/html/index.html)

Example scripts to access the library has been placed [here](https://github.com/mcci-catena/rwc-python-api/tree/master/examples) for your reference.
Example scripts showing how to use the library can be found in the [`examples`](./examples) directory.

## Support

Python library supports RWC5020A firmware software from v1.150 to latest version.
The Python library supports RWC5020x firmware from v1.150 to latest version (v1.305 at time of release).

## Release History

- v1.0.3.10 includes the following changes:
- Fix [#2](https://github.com/mcci-catena/rwc-python-api/issues/2): Updated latest remote commands and added backward compatibility to python library for support of RWC5020x firmware from v1.150 to v1.305.

0 comments on commit 334558d

Please sign in to comment.