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

Lines changed: 2 additions & 0 deletions
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

Lines changed: 2 additions & 1 deletion
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

Lines changed: 5 additions & 3 deletions
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

Lines changed: 5 additions & 3 deletions
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

Lines changed: 3 additions & 9 deletions
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

Lines changed: 2 additions & 1 deletion
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

Lines changed: 2 additions & 0 deletions
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

Lines changed: 2 additions & 0 deletions
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

Lines changed: 2 additions & 0 deletions
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

Lines changed: 2 additions & 0 deletions
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.

0 commit comments

Comments
 (0)