Update README.md

Author: latchdevel

README.md

@@ -1,5 +1,5 @@
 # Raspicode
-High precision Python transmitter of RF 315/433Mhz codes for Raspberry Pi using GPIO via Winring Pi C library.
+High precision Python transmitter of RF 315/433Mhz codes for Raspberry Pi using GPIO via Wiring Pi C library.
 
 Implementation example as simple RESTful API Flask Web Server based to transmit "pilight" string format RF 315/433 Mhz codes named "picode".
 
@@ -38,14 +38,14 @@ The WiringPi is very extensive, includes support for many devices, several proto
 - Remove softPwm and softTone support
 - Remove all PWM init modes
 - Remove threads functions
-- Remove schedulling priority piHiPri 
+- Remove scheduling priority piHiPri 
 - Expose delayMicrosecondsHard function
 
 Wiring Pi is the ideal solution to handle digital GPIOs and solve the timing problem through its **delayMicrosecondsHard()** function.
 There are other ways to handle GPIOs, but they are not as simple or as widespread. See: https://elinux.org/RPi_GPIO_Code_Samples
 
 ### delayMicrosecondsHard(unsigned int howLong)
-Hard loop for watching a built-in counter on the ARM SoC. This uses 100% of assignated CPU something not an issue for recent multi-core SoCs.
+Hard loop for watching a built-in counter on the ARM SoC. This uses 100% of assigned CPU something not an issue for recent multi-core SoCs.
 ```c
 void delayMicrosecondsHard (unsigned int howLong)
 {
@@ -71,28 +71,41 @@ Use only these four native C functions:
 - **digitalWrite(gpio,state)** to set GPIO state, HIGH for odd pulse index or LOW for even pulse index.
 - **delayMicrosecondsHard(usecs)** to high precision microseconds program execution pause.
 
-To build the module:  `$ python3 setup.py develop --user`
+Requires install standard Python modules: **setuptools** and **flask** (for API server):
+ - Install via OS package manager: `apt install python3-setuptools python3-flask`
+ - Or install via **pip** Python package manager:
+   - Install **pip**: `apt install python3-pip` and `pip install setuptools flask`
+
+Requires build C extension Python module: **wiringpiook**
+
+To build the module:
+```sh
+$ cd wiringpiook
+$ python3 setup.py develop --user
+```
 
 The "**wiringpiook**" module only has the function "**tx()**", to transmit pulse train using gpio digital levels.
 Return total transmission time in milliseconds or a negative error code.
 
-Usage: `tx(bcm_gpio,pulse_list,repeats=4)`
+Usage: `tx(bcm_gpio, pulse_list, repeats = 4)`
 
 Example:
 ```python
->>> import wiringpiook
->>> wiringpiook.tx(21,[500,500,2000,2000])
+>>> import wiringpiook as rf
+>>> rf.tx(21,[500,500,2000,2000])
 >>> 20
 ```
 
+The pulse list can be Python generated by [pyPiCode](https://github.com/latchdevel/pyPiCode) module, from any **picode** string or encoding any [pilight supported RF protocols.](https://github.com/latchdevel/picoder?tab=readme-ov-file#show-protocol-list)
+
 ## Process affinity to isolated CPU
 For better timing accuracy when code transmit, the Python script should be executed in a CPU isolated from the OS scheduler.
 
 CPU isolation is a powerful set of features that can be found behind the settings for workloads which rely on specific and often extreme latency or performance requirements. 
 
 "isolcpus" is one of the Linux kernel boot params that isolated certain cpus from kernel scheduling, which is especially useful if you want to dedicate some cpus for special tasks with least unwanted interruption (but cannot get to zero) in a multi-core system.
 
-Remove the specified CPUs, as defined by the cpu_number values, from the general kernel SMP balancing and scheduler algroithms.
+Remove the specified CPUs, as defined by the cpu_number values, from the general kernel SMP balancing and scheduler algorithms.
 
 Raspberry Pi models 2, 3, 4 and Zero 2, have 4 cores, cpus: `{0,1,2,3}`, so is possible to dedicate one CPU to improve the transmission without much impact over system.
 
@@ -116,8 +129,8 @@ $ taskset -c 3 ./raspicode.py
 
 Anyway, if there are CPUs isolated from the OS, Python script will try to set affinity to one of the isolated CPUs:
 ```
-[2022-09-19 00:24:38,782] 1388 WARINING - Process id: 1388 not OS scheduler isolated cpu process affinity
-[2022-09-19 00:24:38,784] 1388 WARINING - Trying to set process affinity cpu: {3}
+[2022-09-19 00:24:38,782] 1388 WARNING - Process id: 1388 not OS scheduler isolated cpu process affinity
+[2022-09-19 00:24:38,784] 1388 WARNING - Trying to set process affinity cpu: {3}
 [2022-09-19 00:24:38,786] 1388 INFO - OK Process id: 1388 affinity cpu: {3} isolated from OS scheduler cpu: {0, 1, 2}
 [2022-09-19 00:24:38,787] 1388 INFO - Web server binding to 0.0.0.0 port 8087 local url http://192.168.1.49:8087/
 ```
@@ -242,7 +255,7 @@ Remember that in any radio frequency system, the most important element is the a
 
 
 # License
-Copyright (c) 2022 Jorge Rivera. All right reserved.
+Copyright (c) 2022-2024 Jorge Rivera. All right reserved.
 
 License GNU Lesser General Public License v3.0.