diff --git a/.github/ISSUE_TEMPLATE/BUG.yaml b/.github/ISSUE_TEMPLATE/BUG.yaml new file mode 100644 index 0000000..df5b74c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG.yaml @@ -0,0 +1,70 @@ +name: Bug Report +description: File a bug report. +title: "[Bug]: " +labels: ["bug", "triage"] +projects: ["proffalken/3"] +assignees: + - proffalken +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: input + id: contact + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: false + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + value: "A bug happened!" + validations: + required: true + - type: input + id: version + attributes: + label: Version + description: What version of the library are you running? + default: 1.0.1 + validations: + required: true + - type: dropdown + id: hardware + attributes: + label: What hardware are you seeing the problem on? + multiple: true + options: + - ESP32 + - ESP8266 + - RP2040 + - Something else + - type: input + id: other_hardware + attributes: + label: Other hardware + description: If you're using something other than the ones in the list above, please put it here + default: 1.0.1 + validations: + required: false + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/proffalken/otel-embedded-cpp/blob/main/CODE_OF_CONDUCT). + options: + - label: I agree to follow this project's Code of Conduct + required: true + diff --git a/.github/ISSUE_TEMPLATE/FEATURE.yaml b/.github/ISSUE_TEMPLATE/FEATURE.yaml new file mode 100644 index 0000000..d446a9b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE.yaml @@ -0,0 +1,61 @@ +name: Feature Request +description: Need something new added to the library? This is the form for you! +title: "[Feature]: " +labels: ["feature", "triage"] +projects: ["proffalken/3"] +assignees: + - proffalken +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to request a new feature! + - type: input + id: contact + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: false + - type: textarea + id: what--do-you-want-to-see? + attributes: + label: What do you want to see? + description: What are we missing in our project? + placeholder: Tell us what you see! + value: "A new feature" + validations: + required: true + - type: dropdown + id: hardware + attributes: + label: What hardware are you using? + multiple: true + options: + - ESP32 + - ESP8266 + - RP2040 + - Something else + - type: input + id: other_hardware + attributes: + label: Other hardware + description: If you're using something other than the ones in the list above, please put it here + validations: + required: false + - type: textarea + id: other info + attributes: + label: What else can you tell us to help us implement this? + description: Is there another project that does similar things? Do you have example code? Please post it here! + render: shell + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/proffalken/otel-embedded-cpp/blob/main/CODE_OF_CONDUCT). + options: + - label: I agree to follow this project's Code of Conduct + required: true + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/README.md b/README.md index 20c7699..28831a0 100644 --- a/README.md +++ b/README.md @@ -77,9 +77,19 @@ The example code shows how to do this with the `time` library and NTP. ```cpp #include -#include #include +#if defined(ESP32) + #include +#elif defined(ESP8266) + #include +#elif defined(ARDUINO_ARCH_RP2040) + // Earle Philhower’s Arduino-Pico core exposes a WiFi.h for Pico W + #include +#else + #error "This example targets ESP32, ESP8266, or RP2040 (Pico W) with WiFi." +#endif + // --------------------------------------------------------- // Import Open Telemetry Libraries // --------------------------------------------------------- diff --git a/src/main.cpp b/src/main.cpp index d176504..be1968a 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -1,7 +1,18 @@ #include -#include #include +// Include the appropriate WiFi library +#if defined(ESP32) + #include +#elif defined(ESP8266) + #include +#elif defined(ARDUINO_ARCH_RP2040) + // Earle Philhower’s Arduino-Pico core exposes a WiFi.h for Pico W + #include +#else + #error "This example targets ESP32, ESP8266, or RP2040 (Pico W) with WiFi." +#endif + // --------------------------------------------------------- // Import Open Telemetry Libraries // ---------------------------------------------------------