examples: fix typos, grammar, punctuation

Author: ThomasWaldmann

examples/blink.py

@@ -8,20 +8,20 @@
 """
 Example for: ESP32
 
-Simple example showing how to control a GPIO pin from the ULP coprocessor.
+Simple example showing how to control a GPIO pin from the ULP co-processor.
 
 The GPIO port is configured to be attached to the RTC module, and then set
-to OUTPUT mode. To avoid re-initializing the GPIO on every wakeup, a magic
+to OUTPUT mode. To avoid re-initializing the GPIO on every wake-up, a magic
 token gets set in memory.
 
 After every change of state, the ULP is put back to sleep again until the
-next wakeup. The ULP wakes up every 500ms to change the state of the GPIO
-pin. An LED attached to the GPIO pin would toggle on and off every 500ms.
+next wake-up. The ULP wakes up every 500 ms to change the state of the GPIO
+pin. An LED attached to the GPIO pin would toggle on and off every 500 ms.
 
-The end of the python script has a loop to show the value of the magic token
+The end of the Python script has a loop to show the value of the magic token
 and the current state, so you can confirm the magic token gets set and watch
 the state value changing. If the loop is stopped (Ctrl-C), the LED attached
-to the GPIO pin continues to blink, because the ULP runs independently from
+to the GPIO pin continues to blink, because the ULP runs independently of
 the main processor.
 """
 
@@ -61,7 +61,7 @@
   move r0, magic
   ld r1, r0, 0
 
-  # test if we have initialised already
+  # test if we have initialized already
   sub r1, r1, token
   jump after_init, eq  # jump if magic == token (note: "eq" means the last instruction (sub) resulted in 0)
 
@@ -72,7 +72,7 @@
   # GPIO shall be output, not input (this also enables a pull-down by default)
   WRITE_RTC_REG(RTC_GPIO_ENABLE_REG, RTC_GPIO_ENABLE_S + gpio, 1, 1)
 
-  # store that we're done with initialisation
+  # store that we're done with initialization
   move r0, magic
   move r1, token
   st r1, r0, 0
@@ -89,17 +89,17 @@
   jump off  # else jump to 'off'
 
 on:
-  # turn on led (set GPIO)
+  # turn on LED (set GPIO)
   WRITE_RTC_REG(RTC_GPIO_OUT_REG, RTC_GPIO_OUT_DATA_S + gpio, 1, 1)
   jump exit
 
 off:
-  # turn off led (clear GPIO)
+  # turn off LED (clear GPIO)
   WRITE_RTC_REG(RTC_GPIO_OUT_REG, RTC_GPIO_OUT_DATA_S + gpio, 1, 0)
   jump exit
 
 exit:
-  halt  # go back to sleep until next wakeup period
+  halt  # go back to sleep until the next wake-up period
 """
 
 binary = src_to_binary(source, cpu="esp32")  # cpu is esp32 or esp32s2
@@ -110,7 +110,7 @@
 ULP_DATA_MASK = 0xffff  # ULP data is only in lower 16 bits
 
 ulp = ULP()
-ulp.set_wakeup_period(0, 500000)  # use timer0, wakeup after 500000usec (0.5s)
+ulp.set_wakeup_period(0, 500000)  # use timer0; wake up after 500000 usec (0.5 s)
 ulp.load_binary(load_addr, binary)
 
 ulp.run(entry_addr)

examples/blink_s2.py

@@ -9,17 +9,17 @@
 Example for: ESP32-S2 and ESP32-S3
 
 The GPIO port is configured to be attached to the RTC module, and then set
-to OUTPUT mode. To avoid re-initializing the GPIO on every wakeup, a magic
+to OUTPUT mode. To avoid re-initializing the GPIO on every wake-up, a magic
 token gets set in memory.
 
 After every change of state, the ULP is put back to sleep again until the
-next wakeup. The ULP wakes up every 500ms to change the state of the GPIO
-pin. An LED attached to the GPIO pin would toggle on and off every 500ms.
+next wake-up. The ULP wakes up every 500 ms to change the state of the GPIO
+pin. An LED attached to the GPIO pin would toggle on and off every 500 ms.
 
-The end of the python script has a loop to show the value of the magic token
+The end of the Python script has a loop to show the value of the magic token
 and the current state, so you can confirm the magic token gets set and watch
 the state value changing. If the loop is stopped (Ctrl-C), the LED attached
-to the GPIO pin continues to blink, because the ULP runs independently from
+to the GPIO pin continues to blink, because the ULP runs independently of
 the main processor.
 """
 
@@ -59,7 +59,7 @@
   move r0, magic
   ld r1, r0, 0
 
-  # test if we have initialised already
+  # test if we have initialized already
   sub r1, r1, token
   jump after_init, eq  # jump if magic == token (note: "eq" means the last instruction (sub) resulted in 0)
 
@@ -87,17 +87,17 @@
   jump off  # else jump to 'off'
 
 on:
-  # turn on led (set GPIO)
+  # turn on LED (set GPIO)
   WRITE_RTC_REG(RTC_GPIO_OUT_REG, RTC_GPIO_OUT_DATA_S + gpio, 1, 1)
   jump exit
 
 off:
-  # turn off led (clear GPIO)
+  # turn off LED (clear GPIO)
   WRITE_RTC_REG(RTC_GPIO_OUT_REG, RTC_GPIO_OUT_DATA_S + gpio, 1, 0)
   jump exit
 
 exit:
-  halt  # go back to sleep until next wakeup period
+  halt  # go back to sleep until the next wake-up period
 """
 
 binary = src_to_binary(source, cpu="esp32s2")  # cpu is esp32 or esp32s2
@@ -108,7 +108,7 @@
 ULP_DATA_MASK = 0xffff  # ULP data is only in lower 16 bits
 
 ulp = ULP()
-ulp.set_wakeup_period(0, 500000)  # use timer0, wakeup after 500000usec (0.5s)
+ulp.set_wakeup_period(0, 500000)  # use timer0; wake up after 500000 usec (0.5 s)
 ulp.load_binary(load_addr, binary)
 
 ulp.run(entry_addr)

examples/counter.py

@@ -8,11 +8,11 @@
 """
 Example for: ESP32
 
-Very basic example showing data exchange main CPU <--> ULP coprocessor.
+Very basic example showing data exchange between the main CPU and the ULP co-processor.
 
 To show that the ULP is doing something, it just increments the value <data>.
-It does that once per ulp timer wakeup (and then the ULP halts until it gets
-waked up via the timer again).
+It does that once per ULP timer wake-up (and then the ULP halts until it gets
+woken up via the timer again).
 
 The timer is set to a rather long period, so you can watch the data value
 incrementing (see loop at the end).
@@ -31,7 +31,7 @@
             add r2, r2, 1    # increment r2
             st r2, r3, 0     # store r2 contents into data ([r3+0])
 
-            halt             # halt ULP co-prozessor (until it gets waked up again)
+            halt             # halt ULP co-processor (until it gets woken up again)
 """
 
 binary = src_to_binary(source, cpu="esp32")  # cpu is esp32 or esp32s2
@@ -42,7 +42,7 @@
 ULP_DATA_MASK = 0xffff  # ULP data is only in lower 16 bits
 
 ulp = ULP()
-ulp.set_wakeup_period(0, 50000)  # use timer0, wakeup after 50.000 cycles
+ulp.set_wakeup_period(0, 50000)  # use timer0; wake up after 50,000 cycles
 ulp.load_binary(load_addr, binary)
 
 mem32[ULP_MEM_BASE + load_addr] = 0x1000

examples/counter_s2.py

@@ -8,11 +8,11 @@
 """
 Example for: ESP32-S2 and ESP32-S3
 
-Very basic example showing data exchange main CPU <--> ULP coprocessor.
+Very basic example showing data exchange between the main CPU and the ULP co-processor.
 
 To show that the ULP is doing something, it just increments the value <data>.
-It does that once per ulp timer wakeup (and then the ULP halts until it gets
-waked up via the timer again).
+It does that once per ULP timer wake-up (and then the ULP halts until it gets
+woken up via the timer again).
 
 The timer is set to a rather long period, so you can watch the data value
 incrementing (see loop at the end).
@@ -31,7 +31,7 @@
             add r2, r2, 1    # increment r2
             st r2, r3, 0     # store r2 contents into data ([r3+0])
 
-            halt             # halt ULP co-prozessor (until it gets waked up again)
+            halt             # halt ULP co-processor (until it gets woken up again)
 """
 
 binary = src_to_binary(source, cpu="esp32s2")  # cpu is esp32 or esp32s2
@@ -42,7 +42,7 @@
 ULP_DATA_MASK = 0xffff  # ULP data is only in lower 16 bits
 
 ulp = ULP()
-ulp.set_wakeup_period(0, 50000)  # use timer0, wakeup after 50.000 cycles
+ulp.set_wakeup_period(0, 50000)  # use timer0; wake up after 50,000 cycles
 ulp.load_binary(load_addr, binary)
 
 mem32[ULP_MEM_BASE + load_addr] = 0x1000

examples/fade_s2.py

@@ -59,9 +59,9 @@
             move r3, wait_on
             st r1, r3, 0 # Overwrite wait_on with new value
 
-            WRITE_RTC_REG(RTC_GPIO_OUT_REG, RTC_GPIO_OUT_DATA_S + led_pin, 1, 0) # turn off led (clear GPIO)
+            WRITE_RTC_REG(RTC_GPIO_OUT_REG, RTC_GPIO_OUT_DATA_S + led_pin, 1, 0) # turn off LED (clear GPIO)
 wait_off:   wait 0 # Placeholder; value overwritten dynamically
-            WRITE_RTC_REG(RTC_GPIO_OUT_REG, RTC_GPIO_OUT_DATA_S + led_pin, 1, 1) # turn on led (set GPIO)
+            WRITE_RTC_REG(RTC_GPIO_OUT_REG, RTC_GPIO_OUT_DATA_S + led_pin, 1, 1) # turn on LED (set GPIO)
 wait_on:    wait 0 # Placeholder; value overwritten dynamically
   
 jump set_waits # Loop program

examples/readgpio.py

@@ -69,10 +69,10 @@
 ULP_DATA_MASK = 0xffff  # ULP data is only in lower 16 bits
 
 ulp = ULP()
-ulp.set_wakeup_period(0, 50000)  # use timer0, wakeup after 50.000 cycles
+ulp.set_wakeup_period(0, 50000)  # use timer0; wake up after 50,000 cycles
 ulp.load_binary(load_addr, binary)
 
-mem32[ULP_MEM_BASE + load_addr] = 0x0  # initialise state to 0
+mem32[ULP_MEM_BASE + load_addr] = 0x0  # initialize state to 0
 ulp.run(entry_addr)
 
 while True:

examples/readgpio_s2.py

@@ -75,10 +75,10 @@
 ULP_DATA_MASK = 0xffff  # ULP data is only in lower 16 bits
 
 ulp = ULP()
-ulp.set_wakeup_period(0, 50000)  # use timer0, wakeup after 50.000 cycles
+ulp.set_wakeup_period(0, 50000)  # use timer0; wake up after 50,000 cycles
 ulp.load_binary(load_addr, binary)
 
-mem32[ULP_MEM_BASE + load_addr] = 0x0  # initialise state to 0
+mem32[ULP_MEM_BASE + load_addr] = 0x0  # initialize state to 0
 ulp.run(entry_addr)
 
 while True:

examples/readgpio_s3.py

@@ -75,10 +75,10 @@
 ULP_DATA_MASK = 0xffff  # ULP data is only in lower 16 bits
 
 ulp = ULP()
-ulp.set_wakeup_period(0, 50000)  # use timer0, wakeup after 50.000 cycles
+ulp.set_wakeup_period(0, 50000)  # use timer0; wake up after 50,000 cycles
 ulp.load_binary(load_addr, binary)
 
-mem32[ULP_MEM_BASE + load_addr] = 0x0  # initialise state to 0
+mem32[ULP_MEM_BASE + load_addr] = 0x0  # initialize state to 0
 ulp.run(entry_addr)
 
 while True:

examples/tsens_s2.py

@@ -41,7 +41,7 @@
 entry:
     move r3, magic
     ld r0, r3, 0
-    jumpr start, token, eq #check if we have already initialized
+    jumpr start, token, eq  # check if we have already initialized
     
 init:
     # Set SENS_TSENS_CLKGATE_EN to enable temperature sensor clock.
@@ -50,14 +50,14 @@
     # Store temperature_data memory location in r2
     move r2, temperature_data
     
-    # store that we're done with initialisation
+    # store that we're done with initialization
     move r0, token
     st r0, r3, 0
     
 start:
-    tsens r0, 1000 # make measurement for 1000 clock cycles
-    st r0, r2, 0 # store the temperature in memory to be read by main CPU
-    halt # go back to sleep until next wakeup period
+    tsens r0, 1000 # make a measurement for 1000 clock cycles
+    st r0, r2, 0 # store the temperature in memory to be read by the main CPU
+    halt # go back to sleep until the next wake-up period
 """
 
 binary = src_to_binary(source, cpu="esp32s2")  # cpu is esp32 or esp32s2