Skip to content

Commit 053aa73

Browse files
committed
Updated C app readme
1 parent 742d4dd commit 053aa73

File tree

1 file changed

+32
-23
lines changed

1 file changed

+32
-23
lines changed

apps/my_sensor_app/README.md

Lines changed: 32 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -16,29 +16,38 @@ sensor data (JSON format) to a CoAP (UDP) Server, such as thethings.io.
1616

1717
<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
1818

19-
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)
20-
21-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\.gitignore
22-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\OLDsrc
23-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\pkg.yml
24-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\README.md
25-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\src
26-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\syscfg.yml
27-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\test
28-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\OLDsrc\geolocate.c
29-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\OLDsrc\geolocate.h
30-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\OLDsrc\listen_sensor.c
31-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\OLDsrc\listen_sensor.h
32-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\OLDsrc\main.c
33-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\OLDsrc\send_coap.c
34-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\OLDsrc\send_coap.h
35-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\src\stub.c
36-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\src\vsscanf.c
37-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\test\README.md
38-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\test\src
39-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\test\src\test_hmac_prng.c
40-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\test\src\test_semihosting_console.c
41-
C:\stm32bluepill-mynewt-sensor\apps\my_sensor_app\test\src\test_temp_stm32.c
19+
The application has been ported to Rust in [`/src`](/src)
20+
21+
The C application code in this folder is no longer in use, except `stub.c` and `vsscanf.c`
22+
23+
[`src`](src): Stub application source files in C for Mynewt build. These C files are compiled into the Mynewt ROM image. These files are stubs, the actual application source files have been ported to Rust in [`/src`](/src)
24+
25+
[`src/stub.c`](src/stub.c): Low-level C functions needed for the Mynewt application
26+
27+
[`src/vsscanf.c`](src/vsscanf.c): Patched version of `apps/my_sensor_app/src/vsscanf.c` that
28+
fixes ESP8266 response parsing bugs. The patched file must be present in that location.
29+
30+
[`pkg.yml`](pkg.yml): Mynewt application info and dependencies
31+
32+
[`syscfg.yml`](syscfg.yml): Mynewt application settings
33+
34+
[`test`](test): Test scripts (incomplete)
35+
36+
[`OLDsrc`](OLDsrc): (NOTUSED) Previous C version of the application
37+
38+
[`OLDsrc/main.c`](OLDsrc/main.c): (NOTUSED) Previous C version of the main program. Contains `main()`
39+
40+
[`OLDsrc/geolocate.c`](OLDsrc/geolocate.c): (NOTUSED) WiFi geolocation functions
41+
42+
[`OLDsrc/geolocate.h`](OLDsrc/geolocate.h): (NOTUSED) WiFi geolocation functions
43+
44+
[`OLDsrc/listen_sensor.c`](OLDsrc/listen_sensor.c): (NOTUSED) Register Listener Function to be called by Mynewt after polling the temperature sensor every 10 seconds
45+
46+
[`OLDsrc/listen_sensor.h`](OLDsrc/listen_sensor.h): (NOTUSED) Register Listener Function to be called by Mynewt after polling the temperature sensor every 10 seconds
47+
48+
[`OLDsrc/send_coap.c`](OLDsrc/send_coap.c): (NOTUSED) Send and receive sensor data via ESP8266 and nRF24L01
49+
50+
[`OLDsrc/send_coap.h`](OLDsrc/send_coap.h): (NOTUSED) Send and receive sensor data via ESP8266 and nRF24L01
4251

4352
## Patch for `vsscanf.c`
4453

0 commit comments

Comments
 (0)