adding community samples guidelines (#2467)
* adding community samples guidelines * Update sdk/docs/iot/README.md Co-authored-by: Eric Wolz <ericwol@microsoft.com> * Update sdk/docs/iot/README.md Co-authored-by: Valerie Avva Lim <54871851+vaavva@users.noreply.github.com> * Update sdk/docs/iot/README.md Co-authored-by: Eric Wolz <ericwol@microsoft.com> * Update sdk/docs/iot/README.md Co-authored-by: Eric Wolz <ericwol@microsoft.com> * Update sdk/docs/iot/README.md Co-authored-by: Valerie Avva Lim <54871851+vaavva@users.noreply.github.com> * Update sdk/docs/iot/README.md Co-authored-by: Valerie Avva Lim <54871851+vaavva@users.noreply.github.com> * Update sdk/docs/iot/README.md Co-authored-by: Dane Walton <dawalton@microsoft.com> * Updates from John's comments * removing samples comments will keep the samples contribution guidelines in a single place * updates from PR comments Co-authored-by: Eric Wolz <ericwol@microsoft.com> Co-authored-by: Valerie Avva Lim <54871851+vaavva@users.noreply.github.com> Co-authored-by: Dane Walton <dawalton@microsoft.com>
This commit is contained in:
Wellington Duraes [MSFT]
GitHub
Родитель
dc41281a07
Коммит
9f79f24436
|
|
@ -43,19 +43,19 @@ View the [Azure Embedded C SDK IoT Samples README](https://github.com/Azure/azur
|
|||
|
||||
For more detailed, step-by-step guides to setup and run the IoT Hub certificate samples from scratch, refer to these documents:
|
||||
|
||||
- Linux: [How to Setup and Run Azure SDK for Embedded C IoT Hub Certificate Samples on Linux](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/docs/how_to_iot_hub_samples_linux.md)
|
||||
- **Linux**: [How to Setup and Run Azure SDK for Embedded C IoT Hub Certificate Samples on Linux](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/docs/how_to_iot_hub_samples_linux.md)
|
||||
|
||||
- Windows: [How to Setup and Run Azure SDK for Embedded C IoT Hub Certificate Samples on Microsoft Windows](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/docs/how_to_iot_hub_samples_windows.md)
|
||||
- **Windows**: [How to Setup and Run Azure SDK for Embedded C IoT Hub Certificate Samples on Microsoft Windows](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/docs/how_to_iot_hub_samples_windows.md)
|
||||
|
||||
- Realtek Ameba D: [How to Setup and Run Azure SDK for Embedded C IoT Hub Client on Realtek AmebaD](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/aziot_realtek_amebaD/readme.md)
|
||||
- **Realtek Ameba D**: [How to Setup and Run Azure SDK for Embedded C IoT Hub Client on Realtek AmebaD](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/aziot_realtek_amebaD/readme.md)
|
||||
|
||||
- Espressif ESP8266: [How to Setup and Run Azure SDK for Embedded C IoT Hub Client on Esp8266 NodeMCU](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/aziot_esp8266/readme.md)
|
||||
- **Espressif ESP8266**: [How to Setup and Run Azure SDK for Embedded C IoT Hub Client on Esp8266 NodeMCU](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/aziot_esp8266/readme.md)
|
||||
|
||||
- Espressif ESP32: [How to Setup and Run Azure SDK for Embedded C IoT Hub Client on ESP32](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/aziot_esp32/readme.md)
|
||||
- **Espressif ESP32**: [How to Setup and Run Azure SDK for Embedded C IoT Hub Client on ESP32](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/aziot_esp32/readme.md)
|
||||
|
||||
- Azure Device Update with Espressif ESP32 on Arduino IDE: [How to Setup and Run Azure SDK for Embedded C ADU on Espressif ESP32](https://github.com/Azure/azure-sdk-for-c-arduino/blob/main/examples/Azure_IoT_Adu_ESP32/readme.md)
|
||||
- **Azure Device Update with Espressif ESP32 on Arduino IDE**: [How to Setup and Run Azure SDK for Embedded C ADU on Espressif ESP32](https://github.com/Azure/azure-sdk-for-c-arduino/blob/main/examples/Azure_IoT_Adu_ESP32/readme.md)
|
||||
|
||||
- VxWorks: [How to Setup and Run Azure SDK for Embedded C IoT Hub Client and Provisioning Client Samples on VxWorks](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/docs/how_to_iot_hub_samples_vxworks.md)
|
||||
- For additional samples, see the **Community Samples** below.
|
||||
|
||||
**Important Note on Linux and Windows Samples**: While Windows and Linux devices are not likely to be considered constrained, these samples enable developers to test the Azure SDK for Embedded C libraries, debug, and step through the code, even without a real device. We understand not everyone will have a real device to test and that sometimes these devices won't have debugging capabilities.
|
||||
|
||||
|
|
@ -63,6 +63,17 @@ For extra guidance, please feel free to watch our Deep Dive Video below which go
|
|||
|
||||
[<img src="./resources/deep_dive_screenshot.png" width="50%">](https://youtu.be/qdb3QIq8msg)
|
||||
|
||||
### Community Samples
|
||||
|
||||
Beyond the samples above, created, maintained and supported by Microsoft, there are additional samples created and maintained by the community:
|
||||
|
||||
- **Raspberry Pi Pico**: [Azure IoT Hub RPI Pico LDR with Cloud to Device Methods](https://github.com/djaus2/Azure_IoT_Hub_Arduino_RPI_Pico_Telemetry/tree/master/Azure_IoT_Hub_RPI_Pico_LightSensor_WithCDM) created and maitained by [David Jones](https://github.com/djaus2), Microsoft MVP Windows Embedded and IoT App Developer.
|
||||
- **VxWorks**: [How to Setup and Run Azure SDK for Embedded C IoT Hub Client and Provisioning Client Samples on VxWorks](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/docs/how_to_iot_hub_samples_vxworks.md)
|
||||
|
||||
If you have any issues with the community samples please let the owner know.
|
||||
|
||||
If you wish to see the link to your sample published here, please refer to the [Contributing](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/docs/iot/README.md#contributing) session in this page.
|
||||
|
||||
## Key Features
|
||||
|
||||
√ feature available √* feature partially available (see Description for details) × feature planned but not supported
|
||||
|
|
@ -236,6 +247,20 @@ void my_telemetry_func(void)
|
|||
|
||||
This project welcomes contributions and suggestions. Find more contributing details [here](https://github.com/Azure/azure-sdk-for-c/blob/main/CONTRIBUTING.md).
|
||||
|
||||
If you wish to contribute with a sample please read the guideline below:
|
||||
|
||||
1. Let us know about your idea for a sample before you create it (open a GitHub issue). This will avoid a conflict in case we're also working on a similar sample.
|
||||
1. Sample owners are fully responsible for their sample code, and any dependency they might have
|
||||
1. Sample owners will guarantee functionality over time,
|
||||
1. Sample owners will answer to questions, comments, GH issues, PRs and any other topics related to their sample implementation,
|
||||
1. Samples that remain in a broken state will be removed, until fixed.
|
||||
1. Microsoft won’t provide support for these samples, and we won’t take GitHub issues, PRs, etc.
|
||||
1. Proposals for new samples will go through a code review process and owners will have to address any major concerns before we add the links to their samples
|
||||
1. Samples approved to be part of the [official samples-list](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/docs/iot/README.md#Community-Samples) will be listed in this page along with the author name.
|
||||
1. We reserve the right to refuse samples which we believe are not relevant to our repo (another reason to follow #1 and check before you start coding).
|
||||
|
||||
If you agree with the guidelines, please fork this repo, create your sample and open a PR with your sample so we can review it (as per #7 above, we won't take the PR but rather add a link to your repo with the sample).
|
||||
|
||||
### License
|
||||
|
||||
Azure SDK for Embedded C is licensed under the [MIT](https://github.com/Azure/azure-sdk-for-c/blob/main/LICENSE) license.
|
||||
|
|
|
|||
|
|
@ -50,19 +50,19 @@ The samples' instructions include specifics for both Windows and Linux based sys
|
|||
|
||||
More detailed step-by-step guides on how to run an IoT Hub Client sample from scratch can be found below:
|
||||
|
||||
- Linux: [How to Setup and Run Azure SDK for Embedded C IoT Hub Certificate Samples on Linux](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/docs/how_to_iot_hub_samples_linux.md)
|
||||
- **Linux**: [How to Setup and Run Azure SDK for Embedded C IoT Hub Certificate Samples on Linux](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/docs/how_to_iot_hub_samples_linux.md)
|
||||
|
||||
- Windows: [How to Setup and Run Azure SDK for Embedded C IoT Hub Certificate Samples on Microsoft Windows](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/docs/how_to_iot_hub_samples_windows.md)
|
||||
- **Windows**: [How to Setup and Run Azure SDK for Embedded C IoT Hub Certificate Samples on Microsoft Windows](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/docs/how_to_iot_hub_samples_windows.md)
|
||||
|
||||
- Realtek Ameba D: [How to Setup and Run Azure SDK for Embedded C IoT Hub Client on Realtek AmebaD](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/aziot_realtek_amebaD/readme.md)
|
||||
- **Realtek Ameba D**: [How to Setup and Run Azure SDK for Embedded C IoT Hub Client on Realtek AmebaD](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/aziot_realtek_amebaD/readme.md)
|
||||
|
||||
- Espressif ESP8266: [How to Setup and Run Azure SDK for Embedded C IoT Hub Client on Esp8266 NodeMCU](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/aziot_esp8266/readme.md)
|
||||
- **Espressif ESP8266**: [How to Setup and Run Azure SDK for Embedded C IoT Hub Client on Esp8266 NodeMCU](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/aziot_esp8266/readme.md)
|
||||
|
||||
- Espressif ESP32: [How to Setup and Run Azure SDK for Embedded C IoT Hub Client on ESP32](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/aziot_esp32/readme.md)
|
||||
- **Espressif ESP32**: [How to Setup and Run Azure SDK for Embedded C IoT Hub Client on ESP32](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/aziot_esp32/readme.md)
|
||||
|
||||
- Espressif ESP32 Over the Air Update: [How to Setup and Run Azure SDK for Embedded C Azure Device Update on ESP32](https://github.com/Azure/azure-sdk-for-c-arduino/tree/main/examples/Azure_IoT_Adu_ESP32)
|
||||
- **Espressif ESP32 Over the Air Update**: [How to Setup and Run Azure SDK for Embedded C Azure Device Update on ESP32](https://github.com/Azure/azure-sdk-for-c-arduino/tree/main/examples/Azure_IoT_Adu_ESP32)
|
||||
|
||||
- VxWorks: [How to Setup and Run Azure SDK for Embedded C IoT Hub Client and Provisioning Client Samples on VxWorks](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/samples/iot/docs/how_to_iot_hub_samples_vxworks.md)
|
||||
- **Community Samples**: there are additional samples created and maintained by the community. Click [here](https://github.com/Azure/azure-sdk-for-c/tree/main/sdk/docs/iot#community-samples) for the full list. If you want to contribute, [here](https://github.com/Azure/azure-sdk-for-c/tree/main/sdk/docs/iot#contributing) are the guidelines.
|
||||
|
||||
To view scenario-focused examples using the API calls, please view the Azure IoT Client [introductory examples](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/docs/iot/README.md#examples). General [coding patterns](https://github.com/Azure/azure-sdk-for-c/blob/main/sdk/docs/iot/coding_patterns.md) that are MQTT stack agnostic are also available to view.
|
||||
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче