Adding sensor app readme

Author: lupyuen

apps/my_sensor_app/README.md

@@ -1,70 +1,46 @@
 # my_sensor_app: Apache Mynewt Sensor Network Application for STM32 Blue Pill with ESP8266 and nRF24L01 (includes Geolocation)
 
-The program runs in 4 modes:
+This C program runs in 4 modes, as described in [_Build Your IoT Sensor Network — STM32 Blue Pill + nRF24L01 + ESP8266 + Apache Mynewt + thethings.io_](https://medium.com/@ly.lee/build-your-iot-sensor-network-stm32-blue-pill-nrf24l01-esp8266-apache-mynewt-thethings-io-ca7486523f5d)
 
 <b>1️⃣ Standalone Node (Blue Pill with ESP8266):</b> The program polls the 
 Blue Pill internal temperature sensor every 10 seconds and transmits the 
 sensor data (JSON format) to a CoAP (UDP) Server, such as thethings.io.  
 
-Edit the settings in `targets/bluepill_my_sensor/syscfg.yml` as follows: 
-
-```yml
-syscfg.vals:
-    # TUTORIAL1: 1
-    TUTORIAL2: 1
-    # TUTORIAL3: 1
-    ...
-```
-
 <b>2️⃣ Sensor Node (Blue Pill with nRF24L01):</b> The program polls the 
 Blue Pill internal temperature sensor every 10 seconds and transmits the 
 sensor data (CBOR format) to the Collector Node.  
 
-Edit the settings 
-in `targets/bluepill_my_sensor/syscfg.yml` as follows: 
-
-```yml
-syscfg.vals:
-    # TUTORIAL1: 1
-    # TUTORIAL2: 1
-    TUTORIAL3: 1
-    ...
-```
-
-Set `SENSOR_NODE_HW_ID_1` to the Hardware ID of the Blue Pill.
-
 <b>3️⃣ Collector Node (Blue Pill with nRF24L01 and ESP8266):</b> The program
 receives sensor data (CBOR format) from the Sensor Node, and transmits the 
 sensor data (JSON format) to a CoAP (UDP) Server, such as thethings.io.
 
-Edit the settings in `targets/bluepill_my_sensor/syscfg.yml` as follows: 
-
-```yml
-syscfg.vals:
-    # TUTORIAL1: 1
-    # TUTORIAL2: 1
-    TUTORIAL3: 1
-    ...
-```
-
-Set `COLLECTOR_NODE_HW_ID` to the Hardware ID of the Blue Pill.
-
 <b>4️⃣ WiFi Geolocation (Blue Pill with ESP8266):</b> The program sends WiFi Access Point MAC Addresses and Signal Strength scanned by ESP8266 to a CoAP (UDP) Server, such as thethings.io.  See https://github.com/lupyuen/thethingsio-wifi-geolocation
 
-thethings.io will call the Google Geolocation API to compute the latitude and longitude based on the WiFi data.  For public display, the computed geolocation is pushed to a web application hosted on Google Cloud App Engine. See https://github.com/lupyuen/gcloud-wifi-geolocation
-
-Edit the settings in `targets/bluepill_my_sensor/syscfg.yml` as follows: 
-
-```yml
-syscfg.vals:
-    # TUTORIAL1: 1
-    TUTORIAL2: 1
-    # TUTORIAL3: 1
-    WIFI_GEOLOCATION: 1
-    ...
-```
-
-# Patch for `vsscanf.c`
+The C application code in this folder is no longer in use, except `stub.c` and `vsscanf.c`. The application has been ported to Rust in [`/src`](/src)
+
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\.gitignore
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\OLDsrc
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\pkg.yml
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\README.md
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\src
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\syscfg.yml
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\test
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\OLDsrc\geolocate.c
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\OLDsrc\geolocate.h
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\OLDsrc\listen_sensor.c
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\OLDsrc\listen_sensor.h
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\OLDsrc\main.c
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\OLDsrc\send_coap.c
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\OLDsrc\send_coap.h
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\src\stub.c
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\src\vsscanf.c
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\test\README.md
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\test\src
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\test\src\test_hmac_prng.c
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\test\src\test_semihosting_console.c
+C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\test\src\test_temp_stm32.c
+
+## Patch for `vsscanf.c`
 
 Note that we are using a patched version of `apps/my_sensor_app/src/vsscanf.c` that
 fixes ESP8266 response parsing bugs.  The patched file must be present in that location.

src/README.md

@@ -4,6 +4,8 @@ This Rust application polls the internal temperature sensor every 10 seconds and
 
 The application is compiled as a Rust library `libmylib.rlib`, which is injected into the Mynewt build.
 
+The application was ported from the C version at [`/apps/my_sensor_app`](/apps/my_sensor_app)
+
 [`lib.rs`](lib.rs): Main library module. Contains `main()`, called by Mynewt at startup, and the panic handler. Imports the modules below via the `mod` directive.
 
 [`base.rs`](base.rs): Common declarations