dotnet / dotnet/iot

Creating the documentation with the essential knowledge (or links)

Open
#2,261 2 comments 2 reactions 1 assignee Assigned to @Copilot View on GitHub
documentation Priority:1 Status: In PR up-for-grabs
Dominant language
C#
Stars
2.4k
Forks
630
Avg merge
11d 3h
Merged PRs (30d)
2

Description

In the triage we observed questions on topics that can be considered essential knowledge to know when interfacing devices and sensors with our library.
We all agreed that it would be important creating one or more documents providing the «essentials» concepts useful for every user. This documentation is meant to collect only the topics that are not related to specific bindings.
These are the topics I suggest to include:
- How to setup and diagnose (this should include how to change the default pins for the peripheral)
- [ ] I2C - https://github.com/dotnet/iot/blob/main/Documentation/raspi-i2c.md
- [ ] SPI - https://github.com/dotnet/iot/blob/main/Documentation/raspi-spi.md
- [ ] PWM - https://github.com/dotnet/iot/blob/main/Documentation/raspi-pwm.md
- [ ] rs232, rs485
- [ ] Creating an IoT project (including the CLI/VS alternative procedures).
- [ ] Choosing the right driver (`libpiod` vs `sysfs` and why)
- [ ] How to run the IoT app in a container (a doc on this topic already exists)
- [ ] Debouncing a signal (see https://github.com/dotnet/iot/issues/2260#issuecomment-1874332565 and other comments). This should not be tied to the Button binding.
- [ ] [Raspberry Pi 5 docs](https://github.com/dotnet/iot/issues/2262)
- [ ] Instructions how to use docker with .NET IoT (see https://github.com/dotnet/iot/issues/764) - we can likely move instructions from https://github.com/dotnet/iot/blob/main/samples/led-blink/README.md#running-in-containers

Please feel free to add other topics or suggest removing one or more of the above list.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.