Skip to content

Commit 37da7ae

Browse files
author
Janne Kiiskilä
committed
Update issue templates & add trace info to README
Update issues templates. Add log enablement information to README.md. - Review feedback from Tero Jääskö. Generic board/network driver issues should be reported to the repositories where those are hosted, not to this repo. This repo is more for the client and the example itself.
1 parent 0a26dad commit 37da7ae

File tree

3 files changed

+72
-0
lines changed

3 files changed

+72
-0
lines changed
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG]"
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is. Please note that issues with the network drivers and boards themselves should be reported to their respective repositories or [Mbed OS](https://github.com/ARMmbed/mbed-os/issues) repository.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1.
16+
2.
17+
3.
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Logs**
24+
Add logs to help explain your problem. Information how to enable logs is available in [README.md](https://github.com/ARMmbed/mbed-os-example-pelion/blob/master/README.md#enabling-logs).
25+
26+
**Host system (please complete the following information):**
27+
- OS: [Windows x.y, Ubuntu x.y, ...]
28+
- Compiler:
29+
- Compiler version:
30+
- Mbed CLI version (if used):
31+
32+
**Device information:**
33+
- Device: [e.g. K64F, Linux/x86, ... ]
34+
- OS: [e.g. Mbed OS 5.15.x]
35+
- Client version: [e.g. 1.0.0]
36+
- Other SW: [attach printout of `mbed ls`]
37+
38+
**Additional context**
39+
Add any other context about the problem here.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[REQ]"
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
Please bear in mind the target of this example - it is supposed to be a very short and simple demo applications, which highlights just the device connectivity and firmware update using the developer flow. With minimal resources and lines of code.
16+
17+
Actual client features can be requested also via the [Pelion client repository](https://github.com/armmbed/mbed-cloud-client/issues).
18+
19+
**Describe alternatives you've considered**
20+
A clear and concise description of any alternative solutions or features you've considered.
21+
22+
**Additional context**
23+
Add any other context or screenshots about the feature request here.

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,16 @@ Check the public tutorial for further information:
9090

9191
[https://www.pelion.com/docs/device-management/current/connecting/mbed-os.html](https://www.pelion.com/docs/device-management/current/connecting/mbed-os.html)
9292

93+
## Enabling logs
94+
95+
Logging (or tracing) can be enabled by modifying the [`mbed_app.json`](https://github.com/ARMmbed/mbed-os-example-pelion/blob/master/mbed_app.json#L19) file.
96+
97+
```
98+
"mbed-trace.enable" : null,
99+
```
100+
101+
By modifying that `null` to 1 and recompiling the application. The application and client uses [`mbed-trace`](https://github.com/ARMmbed/mbed-trace) library for the logging, more fine-grained control is also possible by setting log levels (by calling `mbed_trace_config_set()`) and inclusions/exclusions (by calling `mbed_trace_include_filters_set()` or mbed_trace_exclude_filters_set()`).
102+
93103
## Troubleshooting
94104

95105
- Device initializes but can't register to Pelion

0 commit comments

Comments
 (0)