Skip to content

Commit 609e9f0

Browse files
authored
Various README improvements (#334)
1 parent 1559560 commit 609e9f0

File tree

110 files changed

+307
-223
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+307
-223
lines changed

samples/1-Wire/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Shows how to use the [nanoFramework.Device.OneWire](http://docs.nanoframework.net/api/nanoFramework.Device.OneWire.html) API to read and write from/to a 1-Wire device.
44

5+
The sample is [located here](./).
6+
57
## Hardware requirements
68

79
- A .NET nanoFramework target with 1-Wire capability enabled in the firmware for example a STM32F407_DISCO or any of the ESP32 targets.

samples/ADC/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Shows how to use the [System.Devices.Adc](http://docs.nanoframework.net/api/System.Device.Adc.html) API to read external voltages using an ADC.
44

5+
The sample is [located here](./Program.cs).
6+
57
## Hardware requirements
68

79
Any hardware device running a nanoFramework image.
@@ -31,5 +33,4 @@ The next steps depend on whether you just want to deploy the sample or you want
3133
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
3234

3335
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
34-
3536
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

samples/AMQP/Azure-IoT-Hub/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# 🌶️🌶️ -Azure AMQP sample
22

3-
Shows how to use AMQP.Net Lite library with Azure.
3+
Shows how to use AMQP.Net Lite library.
4+
5+
The sample is [located here](./Program.cs).
46

57
## Hardware requirements
68

@@ -16,7 +18,8 @@ To use a secured (TLS) connection to Azure IoT Hub the following is required:
1618

1719
1. Generate an SAS Token for your device. [Azure IoT Explorer](https://github.com/Azure/azure-iot-explorer) it's a convenient tool to do this for you.
1820
After setting up the access to you IoT Hub, navigate to the device, enter the desired parameters and generate the SAS Token (see the print screen below).
19-
![](azure-iot-explorer-sas.png)
21+
22+
![Azure IoT Explorer](../azure-iot-explorer-sas.png)
2023

2124
### Reference
2225

@@ -41,5 +44,4 @@ The next steps depend on whether you just want to deploy the sample or you want
4144
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
4245

4346
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
44-
4547
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

samples/AMQP/Azure-ServiceBus-Sender/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# 🌶️🌶️ - Azure Service Bus AMQP sample
22

3-
Shows how to use AMQP.Net Lite library with Azure Servic eBus.
3+
Shows how to use Shows how to use AMQP.Net Lite library with Azure Service Bus.
4+
5+
The sample is [located here](./Program.cs).
46

57
## Hardware requirements
68

@@ -16,7 +18,8 @@ To use a secured (TLS) connection to Azure IoT Hub the following is required:
1618

1719
1. Generate an SAS Token for your device. [Azure IoT Explorer](https://github.com/Azure/azure-iot-explorer) it's a convenient tool to do this for you.
1820
After setting up the access to you IoT Hub, navigate to the device, enter the desired parameters and generate the SAS Token (see the print screen below).
19-
![](azure-iot-explorer-sas.png)
21+
22+
![Azure IoT Explorer](../azure-iot-explorer-sas.png)
2023

2124
### Reference
2225

@@ -41,5 +44,4 @@ The next steps depend on whether you just want to deploy the sample or you want
4144
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
4245

4346
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
44-
4547
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

samples/AMQP/README.md

+3-9
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,7 @@
22

33
Shows how to use AMQP.Net Lite library.
44

5-
> **Note:** This sample is part of a large collection of nanoFramework feature samples.
6-
> If you are unfamiliar with Git and GitHub, you can download the entire collection as a
7-
> [ZIP file](https://github.com/nanoframework/Samples/archive/main.zip), but be
8-
> sure to unzip everything to access any shared dependencies.
9-
<!-- For more info on working with the ZIP file,
10-
> the samples collection, and GitHub, see [Get the UWP samples from GitHub](https://aka.ms/ovu2uq).
11-
> For more samples, see the [Samples portal](https://aka.ms/winsamples) on the Windows Dev Center. -->
5+
The sample pack is [located here](./).
126

137
## Hardware requirements
148

@@ -24,7 +18,8 @@ To use a secured (TLS) connection to Azure IoT Hub the following is required:
2418

2519
1. Generate an SAS Token for your device. [Azure IoT Explorer](https://github.com/Azure/azure-iot-explorer) it's a convenient tool to do this for you.
2620
After setting up the access to you IoT Hub, navigate to the device, enter the desired parameters and generate the SAS Token (see the print screen below).
27-
![](azure-iot-explorer-sas.png)
21+
22+
![Azure IoT Explorer](azure-iot-explorer-sas.png)
2823

2924
### Reference
3025

@@ -49,5 +44,4 @@ The next steps depend on whether you just want to deploy the sample or you want
4944
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
5045

5146
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
52-
5347
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

samples/AzureMQTTTwinsBMP280Sleep/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Shows how to use M2Mqtt library with Azure IoT measuring a BMP280 sensor. This leverages the [nanoFramework.IoT.Device](https://github.com/nanoframework/nanoFramework.IoT.Device) repository.
44

5+
The sample is [located here](./).
6+
57
## Hardware requirements
68

79
An hardware device with networking capabilities running a nanoFramework image.
@@ -40,5 +42,4 @@ The next steps depend on whether you just want to deploy the sample or you want
4042
**Important**: You can debug this sample only for one cycle as the device will very quickly go to sleep. If you want to debug, comment the part where it goes to sleep and replace with and infinite thread sleep timeout or a loop to once of the previous part of the code.
4143

4244
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
43-
4445
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

samples/AzureSDK/AzureEdgeOta/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ This examples is a complete code Over the Air (OTA) example using Azure IoT. You
44

55
![Architecture](architecture.png)
66

7+
The sample is [located here](./).
8+
79
## Hardware requirements
810

911
An hardware device with networking capabilities running a nanoFramework image.

samples/AzureSDK/AzureIoTPnP/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ This sample uses the .NET nanoFramework Azure IoT Plug & Play. You can find it h
44

55
Note: the samples include the Azure IoT certificate. You can as well upload it into your device as explained in the [main readme](https://github.com/nanoframework/nanoFramework.Azure.Devices).
66

7+
The sample is [located here](./).
8+
79
## Testing the sample
810

911
This sample uses a specific DTDL as an example, [you'll find it here](https://github.com/Azure/iot-plugandplay-models/blob/main/dtmi/com/example/thermostat-1.json). The Model ID is `dtmi:com:example:Thermostat;1`. This is what is going to be used in this sample.

samples/AzureSDK/AzureSDK/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ This sample uses the .NET nanoFramework Azure IoT Hub SDK with MQTT protocol. Yo
44

55
Note: the samples include the Azure IoT certificate. You can as well upload it into your device as explained in the [main readme](https://github.com/nanoframework/nanoFramework.Azure.Devices).
66

7+
The sample is [located here](./).
8+
79
## Testing the sample
810

911
This sample uses a very popular BMP280 sensor. If you don't have this sensor, there is part of the code that is marked as comment. Just comment those lines and uncomment one of the line. This will simply simulate the sensor with static data.

samples/AzureSDK/AzureSDKBasic/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ You can test this sample by enabling and disabling the device in Azure IoT. You
88

99
![telemetry example](./output.png)
1010

11+
The sample is [located here](./).
12+
1113
## Hardware requirements
1214

1315
An hardware device with networking capabilities running a nanoFramework image.

samples/AzureSDK/AzureSDKBasicFullyManaged/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ You can test this sample by enabling and disabling the device in Azure IoT. You
88

99
![telemetry example](./output.png)
1010

11+
The sample is [located here](./).
12+
1113
## Hardware requirements
1214

1315
You need one modem supporting MQTT abstraction that is supported to use, see [current list here](https://github.com/nanoframework/nanoFramework.IoT.Device/tree/develop/devices/AtModem#documentation).

samples/AzureSDK/AzureSDKSensorCertificate/Readme.md

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Every 3 seconds application reads temperature value from BMP280 sensor and turns
1111

1212
> **Note**: this sample requires a good understanding on how certificate authentication works. And how to set them up properly in Azure IoT.
1313
14+
The sample is [located here](./).
15+
1416
## Getting Started with nanoFramework
1517

1618
* [Getting Started Guide for managed code (C#)](https://docs.nanoframework.net/content/getting-started-guides/getting-started-managed.html)

samples/AzureSDK/AzureSDKSleepBMP280/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Shows how to use the Azure IoT SDK library measuring a BMP280 sensor. This leverages the [nanoFramework.IoT.Device](https://github.com/nanoframework/nanoFramework.IoT.Device) repository and [Azure SDK](https://github.com/nanoframework/nanoFramework.Azure.Devices).
44

5+
The sample is [located here](./).
6+
57
## Hardware requirements
68

79
An hardware device with networking capabilities running a nanoFramework image.

samples/AzureSDK/DpsSampleApp/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ The documentation can be found [here](https://docs.microsoft.com/en-us/azure/iot
88

99
Refer to the main [.NET nanoFramework SDK](https://github.com/nanoframework/nanoFramework.Azure.Devices) to understand the usage.
1010

11+
The sample is [located here](./).
12+
1113
## Usage
1214

1315
The device **must** be connected to the Internet and have a valid date and time.

samples/AzureSDK/README.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ These samples are using [Azure IoT Hub SDK](https://github.com/nanoframework/nan
44

55
## Samples
66

7-
* [🌶️🌶️ - Azure IoT Hub SDK with MQTT protocol](AzureSDK)
8-
* [🌶️🌶️🌶️ - Complete Azure MQTT sample using BMP280 sensor](AzureSDKSleepBMP280)
9-
* [🌶️🌶️ - Azure IoT Device Provisioning Service (DPS) example](DpsSampleApp)
10-
* [🌶️🌶️🌶️ - Azure SDK with X.509 CA Signed certificate sample using BMP280 Sensor](AzureSDKSensorCertificate)
7+
- [🌶️🌶️ - Azure IoT Hub SDK with MQTT protocol](AzureSDK)
8+
- [🌶️🌶️🌶️ - Complete Azure MQTT sample using BMP280 sensor](AzureSDKSleepBMP280)
9+
- [🌶️🌶️ - Azure IoT Device Provisioning Service (DPS) example](DpsSampleApp)
10+
- [🌶️🌶️🌶️ - Azure SDK with X.509 CA Signed certificate sample using BMP280 Sensor](AzureSDKSensorCertificate)
1111

1212
## Build the sample
1313

@@ -28,5 +28,4 @@ The next steps depend on whether you just want to deploy the sample or you want
2828
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
2929

3030
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
31-
3231
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

samples/Blinky/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Shows how to use the [System.Device.Gpio](http://docs.nanoframework.net/api/System.Device.Gpio.html) API to set GPIO pins.
44

5+
The sample is [located here](./Blinky/Program.cs).
6+
57
## Hardware requirements
68

79
Any hardware device running a nanoFramework image.
@@ -33,5 +35,4 @@ The next steps depend on whether you just want to deploy the sample or you want
3335
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
3436

3537
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
36-
3738
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.
+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 🌶️🌶️🌶️ - Create an IBeacon:
1+
# 🌶️🌶️🌶️ - Create an IBeacon
22

33
This shows how to create a Bluetooth iBeacon.
44
The sample contains a **Beacon class** which does hard work and can be easily used in other applications.
@@ -7,3 +7,5 @@ You will be able to see iBeacon advertisements in the relevant applications.
77
Suitable Phone applications: "LightBlue" or "nRF Connect"
88

99
See [main Bluetooth sample's readme](../README.md) for more information.
10+
11+
The sample is [located here](./Program.cs).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
esp32
2+
ble

samples/Bluetooth/BluetoothLESample1/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,5 @@ You will be able to connect to the service and read values or subscribe to be No
1515
Suitable Phone apps: "LightBlue" or "nRF Connect"
1616

1717
See [main Bluetooth sample's readme](../README.md) for more information.
18+
19+
The sample is [located here](./Program.cs).

samples/Bluetooth/BluetoothLESample2/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,5 @@ The 2nd Characteristic allows writes but requires to be paired for the read.
1818
The 3rd Characteristic allows writes but requires to be paired with authentication for the read.
1919

2020
See [main Bluetooth sample's readme](../README.md) for more information.
21+
22+
The sample is [located here](./Program.cs).

samples/Bluetooth/BluetoothLESample3/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,5 @@ This sample class includes these 4 but other types can easily added to class. Mu
2828
The sample shows 3 Temperatures (Instantaneous, Maximum, Minimum) added to service and a humidity sensor.
2929

3030
See [main Bluetooth sample's readme](../README.md) for more information.
31+
32+
The sample is [located here](./Program.cs).

samples/Bluetooth/BluetoothLESerial/README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 🌶️ - Bluetooth Low Energy Serial profile sample
22

3-
Shows how to use the Serial Protocol Profile APIs included in the [NanoFramework.Device.Bluetooth](http://docs.nanoframework.net/api/NanoFramework.Device.Bluetooth.html).
3+
Shows how to use the Serial Protocol Profile APIs included in the [NanoFramework.Device.Bluetooth](http://docs.nanoframework.net/api/NanoFramework.Device.Bluetooth.html).
44

55
The sample allows a Bluetooth Terminal program to connect and send/receive text messages. There are a number of applications on both Android and IOS
66
that will work.
@@ -9,7 +9,9 @@ The device should be seen as "nanoFrameworkSerial" when scanning for the device.
99

1010
Send device 'help' to get information on what messages it will respond to.
1111

12-
This sample is a example of what you could do to provision your device with required data like wifi credentials, name etc.
12+
This sample is a example of what you could do to provision your device with required data like wifi credentials, name etc.
13+
14+
The sample is [located here](./Program.cs).
1315

1416
## Hardware requirements
1517

@@ -45,5 +47,4 @@ The next steps depend on whether you just want to deploy the sample or you want
4547
- To debug the sample and then run it, press F5 or select `Debug > Start Debugging`.
4648

4749
> **Important**: Before deploying or running the sample, please make sure your device is visible in the Device Explorer.
48-
4950
> **Tip**: To display the Device Explorer, go to Visual Studio menus: `View > Other Windows > Device Explorer`.

samples/Bluetooth/BroadcastValues/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,5 @@ You will be able see advertisements from device with ManufacterData value changi
1212
Suitable Phone applications: "LightBlue" or "nRF Connect"
1313

1414
See [main Bluetooth sample's readme](../README.md) for more information.
15+
16+
The sample is [located here](./Program.cs).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ble

samples/Bluetooth/Central1/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
# 🌶️🌶️ - Bluetooth Low energy: Watch for Bluetooth Advertisments
1+
# 🌶️🌶️ - Bluetooth Low energy: Watch for Bluetooth Advertisements
22

3-
This sample shows how to create a BluetoothLEAdvertisementWatcher class to watch for Bluetooth Advertisments.
3+
This sample shows how to create a BluetoothLEAdvertisementWatcher class to watch for Bluetooth Advertisements.
44

5-
Runs this sample and all the Bluetooth LE Advertisments will be listed.
5+
Runs this sample and all the Bluetooth LE Advertisements will be listed.
66

77
See [main Bluetooth sample's readme](../README.md) for more information.
8+
9+
The sample is [located here](./Program.cs).
+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ble

samples/Bluetooth/Central2/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
# 🌶️🌶️ - Bluetooth Low energy: Environmental Sensor data collection.
1+
# 🌶️🌶️ - Bluetooth Low energy: Environmental Sensor data collection
22

33
Sample to collect temperature values from a collection of
4-
Environmental Sensor devices.
4+
Environmental Sensor devices
55

6-
This sample will watch for Environmental sensors advertisements and connect to sensor reading temperture values.
6+
This sample will watch for Environmental sensors advertisements and connect to sensor reading temperature values.
77

88
Shows how to watch for advertisements and connect to devices.
99

1010
Designed to work with the Bluetooth Sample 3.
1111

1212
See [main Bluetooth sample's readme](../README.md) for more information.
13+
14+
The sample is [located here](./Program.cs).
+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ble

samples/Bluetooth/Central3/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# 🌶️🌶️🌶️ - Bluetooth Low energy: Demonstrates pairing and authentication in Client program.
1+
# 🌶️🌶️🌶️ - Bluetooth Low energy: Demonstrates pairing and authentication in Client program
22

3-
Sample to show how to Watch for advertisements and connect to a device which requires encryption and
4-
authentication to access the Characteristics value.
3+
Sample to show how to Watch for advertisements and connect to a device which requires encryption and authentication to access the Characteristics value.
54

65
This sample works with the BluetoothLESample2 sample as the server.
76

87
Start the BluetoothLESample2 on another device and then run this sample.
98

109
Pairing can be done before or ad hoc when the accessing the Characteristic.
11-
If Characteristic requires security or Authentication when accessed the system will automatically
12-
start a pairing operation.
10+
If Characteristic requires security or Authentication when accessed the system will automatically start a pairing operation.
1311

1412
See [main Bluetooth sample's readme](../README.md) for more information.
13+
14+
The sample is [located here](./Program.cs).
+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ble
+9-7
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
# 🌶️🌶️🌶️ - Improv Wifi provisioning
22

3-
This sample shows the use of the *Improv class* to provision the Wifi credentials for an ESP32 device via Bluetooth LE.
3+
This sample shows the use of the `Improv` class to provision the Wifi credentials for an ESP32 device via Bluetooth LE.
44

5-
The device will advertise with the name "Improv sample" and support the *Improv Service* allowing the Wifi Credentials to be setup directly from the Improv test page.
6-
or any other web page.
5+
The device will advertise with the name `Improv sample` and support the `Improv Service` allowing the Wifi Credentials to be setup directly from the Improv test page or any other web page.
76

87
This is an initial working version of the *Improv* class showing what can be done.
8+
99
Probably later this class can be moved to a separate repo, so it has its own nuGet package to make it easy to be consumed by applications.
1010

11-
*Improv* is a free open standard which allows the device to be provisioned directly from a web page.
12-
This works for Chrome and Edge browsers.
11+
`Improv` is a free open standard which allows the device to be provisioned directly from a web page. This works for Chrome and Edge browsers.
12+
13+
For more information on the `Improv` standard and a test page, see the [official Improv website](https://www.improv-wifi.com/).
14+
15+
[See](https://www.improv-wifi.com/code/) for details on including it into other web pages.
1316

14-
For more information on the *Improv* standard and a test page, see: <https://www.improv-wifi.com/>
15-
See <https://www.improv-wifi.com/code/> for details on including it into other web pages.
17+
The sample is [located here](./Program.cs).
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
esp32
22
ble
3+
wifi

0 commit comments

Comments
 (0)