indent

Author: xeronm

README.md

@@ -15,7 +15,7 @@ Please feel free to use, improve, report bugs, etc. And if you find my work usef
 Contributors:
 - Denis Muratov <[email protected]>
 
-## 1. References
+## References
 
  - [esp-open-sdk]: Free and open (as much as possible) integrated SDK for ESP8266/ESP8285 chips
  - [docker-esp8266]: Toolchain for esp8266 based on crosstool-NG 1.22.x
@@ -25,35 +25,35 @@ Contributors:
 [docker-esp8266]: https://github.com/xeronm/docker-esp8266
 [esp8266-tshcli]: https://github.com/xeronm/esp8266-tshcli
 
-## 2. Definitions and Abbrevations
+## Definitions and Abbrevations
 
-## 3. Buld Firmware from scratch
+## Buld Firmware from scratch
 
-### 3.1. Prepare build environment
+### Prepare build environment
 
 ```
 $ sudo docker pull dtec/esp8266:1.22-p
 $ git clone https://github.com/xeronm/esp8266-tsh.git
 $ cd esp8266-tsh
 ```
 
-### 3.2. Configure project
+### Configure project
 
 Configurables are:
 - APP, SPI_MODE, SDK_IMAGE_TOOL in `Makefile`
 - Global project defines in `./include/core/config.h`
 
-### 3.3. Buld Firmware
+### Buld Firmware
 
 ```
 $ sudo docker run --name esp8266 -it --rm -v $PWD:/src/project dtec/esp8266:1.22-p
 /src/project# make build
 ```
 
 
-## 4. Usage
+## Usage
 
-### 4.1. Service catalog
+### Service catalog
 
 | Id | Name      | Description                  |
 | ---| ----------| -----------------------------|
@@ -67,11 +67,11 @@ $ sudo docker run --name esp8266 -it --rm -v $PWD:/src/project dtec/esp8266:1.22
 |  7 | gpioctl   | GPIO control management      |
 |  8 | sched     | Cron-like scheduler          |
 
-### 4.2. Service documentation
+### Service documentation
 
-#### 4.2.1. System logging (syslog)
+#### System logging (syslog)
 
-##### 4.2.1.2. Configuration parameters
+##### Configuration parameters
 
 |Parameter|Level|Description|Default|
 |---------|-----|-----------|-------|
@@ -82,9 +82,9 @@ Example:
   { "syslog.Log-Severity": 4 }
 ```
 
-#### 4.2.2. esp8266 system management (espadmin)
+#### esp8266 system management (espadmin)
 
-##### 4.2.2.1. Configuration parameters
+##### Configuration parameters
 
 |Parameter|Level|Description|Default|
 |---------|-----|-----------|-------|
@@ -95,7 +95,7 @@ Example:
 |esp.WiFi-Password| 1 | Password |  |
 |esp.WiFi-Auto-Connect| 1 | Station mode auto connect (0- disabled, 1- enabled)| 1- enabled |
 |esp.WIFI-Soft-AP| 0 | Soft AP mode parameters (object) |
-|esp.WiFi-SSID| 1 | SSID | `${HOST_NAME}` or `ESP_${MAC48[3:6]}` |
+|esp.WiFi-SSID| 1 | SSID | `${HOST_NAME}` or `ESP_${MAC48[3:6]}`> |
 |esp.WiFi-Password| 1 | Password | `${MAC48}` |
 |esp.WiFi-Auth-Mode| 1 | Soft AP authentication mode (0- open, 1- wep, 2- wpa psk, 3- wpa2 psk, 4- wpa/wpa2 psk) | 4- wpa/wpa2 psk |
 
@@ -120,9 +120,9 @@ Example:
   }
 ```
 
-#### 4.2.3. UDP system management (udpctl)
+#### UDP system management (udpctl)
 
-##### 4.2.3.1. Configuration parameters
+##### Configuration parameters
 
 |Parameter|Level|Description|Default|
 |---------|-----|-----------|-------|
@@ -134,53 +134,52 @@ Example:
 Example:
 ```
   {
-    "common.IP-Port": 3901,
+    "common.IP-Port": 3900,
     "uctl.Secret": "mysecret"
   }
 ```
 
 
-#### 4.2.4. Network Time Protocol client (ntp)
+#### Network Time Protocol client (ntp)
 
-##### 4.2.4.1. Configuration parameters
+##### Configuration parameters
 
 |Parameter|Level|Description|Default|
 |---------|-----|-----------|-------|
 |common.Time-Zone| 0 | Local Timezone (1/4 hours) | +0:00 |
-|ntp.Poll-Interval| 0 |  Poll interval (minutes) | 15 |
+|ntp.Poll-Interval| 0 |  Poll interval (minutes) | 20 |
 |ntp.Peer| 0 |NTP Server peers (object list 0-2 items) | 0.pool.ntp.org, 1.pool.ntp.org |
 |common.Host-Name| 1 | NTP Server host |  |
 
 Example:
 ```
   { 
     "common.Time-Zone": "+3:00", 
-    "ntp.Poll-Interval": 15, 
+    "ntp.Poll-Interval": 10, 
     "ntp.Peer": [
       { "common.Host-Name": "0.pool.ntp.org" }, 
       { "common.Host-Name": "1.pool.ntp.org" }
     ]
   }
 ```
 
-## 5. Examples
+## Examples
 
-### 5.1. FAN Control Unit
+### FAN Control Unit
 
-#### 5.1.1. Scope
+#### Scope
 
 Bathroom FAN control unit with DHT11 sensor and 1P solid state relay.
 
 Conrol Logic Goals
-- Force turn on FAN when system startup and every day-time hour. Turn off after 12 minutes timeout.
-- Turn on/off FAN when humidity reached high/low threshold. Regardless of humidity turn off after 30 minutes.
+- Force turn on FAN when system startup and every day-time hour. Turn off after 10 minutes timeout.
+- Turn on/off FAN when humidity reached high/low threshold. Regardless of humidity turn off after 20 minutes.
 - Cool-down turn on/off humidity event by 5 minutes after last on/off event.
 
+#### Flash Initial Firmware Image
 
-#### 5.1.2. Flash Initial Firmware Image
-
-###### 1. Connect ESP12E to host by serial cable
-###### 2. Use esptool for query module `MAC` (in our example was `5ccf7f85e196`)
+1. Connect ESP12E to host by serial cable
+2. Use esptool for query module `MAC` (in our example was `5ccf7f85e196`)
 ```
 $  sudo esptool.py -p /dev/ttyUSB0 -b 115200 read_mac
 esptool.py v2.5.0
@@ -197,7 +196,7 @@ MAC: 5c:cf:7f:85:e1:96
 Hard resetting via RTS pin...
 ```
 
-###### 3. Flash Things-Shell firmware
+3. Flash Things-Shell firmware
 ```
 $ cd ./bin
 $ sudo esptool.py -p /dev/ttyUSB0 -b 115200 write_flash --flash_freq 80m --flash_mode dio --flash_size 32m --verify \
@@ -208,8 +207,8 @@ $ sudo esptool.py -p /dev/ttyUSB0 -b 115200 write_flash --flash_freq 80m --flash
     0x3fe000 blank.bin
 ```
 
-###### 4. Connect to hidden WiFi AP `ESPTSH_85e196` (last 6 digit of MAC) with password `5ccf7f85e196` (MAC)
-###### 5. Check that firmware and `udpctl` service works. Query system information
+4. Connect to hidden WiFi AP `ESPTSH_85e196` (last 6 digit of MAC) with password `5ccf7f85e196` (MAC)
+5. Check that firmware and `udpctl` service works. Query system information
 ```
 $ ./tcli.py -H 192.168.4.1 -s 5ccf7f85e196 system info
 {
@@ -243,9 +242,9 @@ $ ./tcli.py -H 192.168.4.1 -s 5ccf7f85e196 system info
 }
 ```
 
-#### 5.1.3. Configure System
+#### Configure System
 
-###### 1. Setup Wi-Fi station mode and system description
+1. Setup Wi-Fi station mode and system description
 ```
 $ ./tcli.py -H 192.168.5.86 -s 5ccf7f85e196 service config set -m '
 {   
@@ -266,7 +265,7 @@ $ ./tcli.py -H 192.168.5.86 -s 5ccf7f85e196 service config set -m '
 ]}'
 ```
 
-###### 2. Setup Time-Zone
+2. Setup Time-Zone
 ```
 $ ./tcli.py -H 192.168.5.86 -s 5ccf7f85e196 service config set -m '
 {
@@ -279,7 +278,7 @@ $ ./tcli.py -H 192.168.5.86 -s 5ccf7f85e196 service config set -m '
 }'
 ```
 
-###### 3. Save configuration
+3. Save configuration
 ```
 $ ./tcli.py -H 192.168.5.86 -s 5ccf7f85e196 service config save -m '
 {
@@ -291,7 +290,7 @@ $ ./tcli.py -H 192.168.5.86 -s 5ccf7f85e196 service config save -m '
 ```
 
 
-#### 5.1.4. Configure Script Logic and Schedule
+#### Configure Script Logic and Schedule
 
 Following terms were used:
 - global variable `last_ev` - last state change event (0- reset state, 1-force power on, 2- humidity high threshold, 3- humidity low threshold, 4- power off timeout)
@@ -300,8 +299,12 @@ Following terms were used:
 - humidity turn on threshold: >= 36%
 - humidity turn off threshold: < 36%
 - used estimated moving average results from DHT sensor
+- force on power off timeout: 12 minutes
+- humidity on power off timeout: 30 minutes
+- humidity on/off cool down timeout: 5 minutes
+
 
-###### 1. Make light-shell script with control rule logic. Solution is not optimal, may improved by using dht service thresholds and multicast signal handling
+1. Make light-shell script with control rule logic. Solution is not optimal, may improved by using dht service thresholds and multicast signal handling
 ```
   ## last_dt; ## last_ev; # sdt := sysctime(); 
   (last_ev <= 0) ?? { gpio_set(0, 0); last_ev := 1; last_dt := sdt; print(last_ev) }; 	// set initial state, force power on
@@ -312,7 +315,7 @@ Following terms were used:
   ((last_ev = 1) && (last_dt + 720 < sdt) || (last_ev = 2) && (last_dt + 1800 < sdt)) ?? { gpio_set(0, 1); last_ev := 4; last_dt := sdt; print(last_ev) };	// power off timeout
 ```
 
-###### 2. Add peristent named statement `fan_control` for common control logic
+2. Add peristent named statement `fan_control` for common control logic
 ```
 $ ./tcli.py -H 192.168.5.86 -s 5ccf7f85e196 lsh add -m '
 {
@@ -322,7 +325,7 @@ $ ./tcli.py -H 192.168.5.86 -s 5ccf7f85e196 lsh add -m '
 }'
 ```
 
-###### 3. Add peristent named statement `fan_force_on` for force turn on by schedule, startum signal, or manual run
+3. Add peristent named statement `fan_force_on` for force turn on by schedule, startum signal, or manual run
 ```
 $ ./tcli.py -H 192.168.5.86 -s 5ccf7f85e196 lsh add -m '
 {
@@ -332,7 +335,7 @@ $ ./tcli.py -H 192.168.5.86 -s 5ccf7f85e196 lsh add -m '
 }'
 ```
 
-###### 4. Perform simple tests
+4. Perform simple tests
 ```
   # Force turn on when no initial state
 $ ./tcli.py -H 192.168.5.86 -s 5ccf7f85e196 lsh run -m '{ "lsh.Statement-Name": "fan_control" }'
@@ -386,7 +389,7 @@ $ ./tcli.py -H 192.168.5.86 -s 5ccf7f85e196 lsh run -m '{ "lsh.Statement-Name":
 }
 ```
 
-###### 5. Output results on uart port
+5. Output results on uart port
 ```
 [1200.868] [warn ][ntp] adjust time to: 2018.12.07 08:35:35+3:00 offset:-1.7
 [1674.718] [info ][lwsh] load "fan_control"
@@ -397,7 +400,7 @@ $ ./tcli.py -H 192.168.5.86 -s 5ccf7f85e196 lsh run -m '{ "lsh.Statement-Name":
 [2639.283] [info ][lwsh] fan_force_on out: 1
 ```
 
-###### 6. Add schedules. `fan_force_on` at system startup and every 30th minutes of 09 - 21 day hours. `fan_control` at 15th seconds of every minute
+6. Add schedules. `fan_force_on` at system startup and every 30th minutes of 09 - 21 day hours. `fan_control` at 15th seconds of every minute
 ```
 $ ./tcli.py -H 192.168.5.86 -s 5ccf7f85e196 sched add -m '{
   "sched.Entry-Name": "fan_force_on",
@@ -416,10 +419,10 @@ $ ./tcli.py -H 192.168.5.86 -s 5ccf7f85e196 sched add -m '{
 ```
 
 
-## 6. Appendix: Memos
+## Appendix: Memos
 
-### 6.1. Indent
+### Indent
 ```
-$ find ./ -name '*.h' -exec indent -l120 -brs -br -i4 -ci4 -di16 -sc {} -o {} \;
-$ find ./ -name '*.c' -exec indent -l120 -brs -br -i4 -ci4 -di16 -sc {} -o {} \;
+$ find ./ -name '*.h' -exec indent -l120 -brs -br -i4 -ci4 -di16 --no-tabs -sc {} -o {} \;
+$ find ./ -name '*.c' -exec indent -l120 -brs -br -i4 -ci4 -di16 --no-tabs -sc {} -o {} \;
 ```

arch/default/sysinit.c

@@ -46,16 +46,16 @@ system_get_time (void)
     return 0;
 }
 
-uint32          ICACHE_FLASH_ATTR 
-system_rtc_clock_cali_proc(void)
+uint32          ICACHE_FLASH_ATTR
+system_rtc_clock_cali_proc (void)
 {
     return 0;
 }
 
-size_t          ICACHE_FLASH_ATTR 
-fio_user_format(uint32 size)
+size_t          ICACHE_FLASH_ATTR
+fio_user_format (uint32 size)
 {
-    FILE * fp = fopen ("./flash_userdata.bin", "w+");
+    FILE           *fp = fopen ("./flash_userdata.bin", "w+");
     if (!fp)
         return 0;
 
@@ -64,34 +64,34 @@ fio_user_format(uint32 size)
 }
 
 size_t          ICACHE_FLASH_ATTR
-fio_user_read(uint32 addr, uint32 *buffer, uint32 size) 
+fio_user_read (uint32 addr, uint32 * buffer, uint32 size)
 {
-    FILE * fp = fopen ("./flash_userdata.bin", "rb");
+    FILE           *fp = fopen ("./flash_userdata.bin", "rb");
     if (!fp || fseek (fp, addr, SEEK_SET))
         return 0;
-    size_t res = fread (buffer, 1, size, fp);
+    size_t          res = fread (buffer, 1, size, fp);
     fclose (fp);
 
     return res;
 }
 
-size_t          ICACHE_FLASH_ATTR 
-fio_user_write(uint32 addr, uint32 *buffer, uint32 size)
+size_t          ICACHE_FLASH_ATTR
+fio_user_write (uint32 addr, uint32 * buffer, uint32 size)
 {
-    FILE * fp = fopen ("./flash_userdata.bin", "rb+");
+    FILE           *fp = fopen ("./flash_userdata.bin", "rb+");
     if ((!fp) && (errno == ENOENT))
         fp = fopen ("./flash_userdata.bin", "wb+");
 
     if (!fp || fseek (fp, addr, SEEK_SET))
         return 0;
-    size_t res = fwrite (buffer, 1, size, fp);
+    size_t          res = fwrite (buffer, 1, size, fp);
     fclose (fp);
 
     return res;
 }
 
-size_t          ICACHE_FLASH_ATTR 
-fio_user_size(void)
+size_t          ICACHE_FLASH_ATTR
+fio_user_size (void)
 {
-    return 2*1024*1024; // 2 Mb
+    return 2 * 1024 * 1024;     // 2 Mb
 }