Merge pull request #19 from lnls-sirius/upgrade-performance

Increasing performance for python data transfer
lnls-sirius · Jan 21, 2020 · e2e0343 · e2e0343
2 parents b2aea6c + cb6029c
commit e2e0343
Show file tree

Hide file tree

Showing 10 changed files with 319 additions and 254 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,7 @@
 *.swp
-
+*.pyc
 src/library/build/
 src/library/dist/
 src/library/PRUserial485.egg-info/
 src/library/PRUserial485/__pycache__/
+src/library/VERSION-HASH
diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@ _**Before using it**_
 
 1. Apply the Device Tree Overlay (DTO) to configure Beaglebone pins to PRU. Run `overlay.sh` script each time you restart your Beaglebone.
 
-2. In your python code, you can just:
+2. In your python3 code, you can just:
 ```python
 import PRUserial485
 ```  
@@ -58,13 +58,13 @@ _**General Purpose**_
    Closes PRUs and memory mapping.
 
 
-- ```PRUserial485_write(char_list data, float timeout)```
+- ```PRUserial485_write(bytes, float timeout)```
 
    Sending data through RS485 network  
 
    _*Parameters*_
   * _data:_  
-  Python char list containing values to be transmitted through serial network.
+  Python bytes containing values to be transmitted through serial network.
   * _timeout:_  
   Maximum waiting time to start getting an answer, in milliseconds (ms). Minimum: 15ns / Maximum: 64s. If 0, does not wait for response. ATTENTION: in slave mode, this parameter is ignored.  
 
@@ -79,12 +79,12 @@ _**General Purpose**_
 
    Receiving data through RS485 network  
 
-   _*Return*_: List of characters corresponding to data received.
+   _*Return*_: bytes corresponding to data received.
 
 
 _**Curves**_
 
-- ```PRUserial485_curve(float_list curve1, float_list curve2, float_list curve3, float_list curve4, int block)```
+- ```PRUserial485_curve(int block, [float_list curve1, float_list curve2, float_list curve3, float_list curve4])```
 
    Storing curves into memory. Each curve correspond to a power supply in the crate.   
 
@@ -108,7 +108,7 @@ _**Curves**_
 
    Read block identification which will be performed in next cycle.    
 
-   _*Returns*_: Block indentification (0 to 3)
+   _*Returns*_: Block identification (0 to 3)
 
 
 - ```PRUserial485_set_curve_pointer(int next_point)```
@@ -156,7 +156,7 @@ _**Sync Operation**_
 
    Verifies whether PRU is waiting for a sync pulse or not    
 
-   _*Returns*_: boolean True or False
+   _*Returns*_: 1 if true, 0 if false
 
 
 - ```PRUserial485_read_pulse_count_sync()```

diff --git a/src/library/PRUserial485/UpdatesFromLastCommit.txt b/src/library/PRUserial485/UpdatesFromLastCommit.txt
diff --git a/src/library/PRUserial485/VERSION b/src/library/PRUserial485/VERSION
diff --git a/src/library/PRUserial485/__init__.py b/src/library/PRUserial485/__init__.py
diff --git a/src/library/PRUserial485/implementation.py b/src/library/PRUserial485/implementation.py
diff --git a/src/library/VERSION b/src/library/VERSION
@@ -1 +1 @@
-1.3.3
+1.4.0