Add libraries documentation.

pull/1/head
Luigi Cruz 2021-03-11 23:11:59 -03:00
rodzic 8fc012c761
commit 9764e55e3d
5 zmienionych plików z 54 dodań i 12 usunięć

Wyświetl plik

@ -1,10 +1,19 @@
# pico-stuff
I add my Pi Pico (RP2040) stuff here.
# Pico Stuff
I add my Pi Pico (RP2040) stuff here. There are complete [apps](/apps) and [libraries](/lib) for sensors or complicated tasks.
## Header-Only Libraries
- BMP180
## Libraries
- [BMP180](/lib/bmp1880): Header-only library for the BMP180 atmospheric pressure sensor.
## Apps
- [PiccoloSDR](/apps/piccolosdr): A primited direct-sampling SDR.
- [ADC DMA Chain](/apps/adc_dma_chain): Chained DMA data acquisition from the ADC.
- [Barometer](/apps/barometer): Barometer polling the temperature and atmospheric pressure from a BMP180.
- [Iperf Server](/apps/iperf_server): A tool to measure the performance of the TinyUSB's TCP/IP stack over USB.
- [TCP Server](/apps/tcp_server): A TCP server example to send high-frequency data to the host computer.
## Installation
Some projects may require a patched version of the `pico-sdk` or `pico-extras`.
```bash
$ git clone --recursive git@github.com:luigifcruz/pico-stuff.git
$ cd pico-stuff
@ -14,9 +23,23 @@ $ PICO_SDK_PATH=../pico-sdk cmake ..
$ make -j$(nproc -n)
```
## Debug
For debug add `#define DEBUG` before the `#include` of a header-only library.
## About the project
This project was created and maintained since 2021 by [Luigi Cruz](https://luigi.ltd).
## Usage
Q: How can I use these libraries on my project?
A: Just copy and paste the header-only library file to your project.
### Donation
Donations are welcome. I have no commercial interest in this code. Your donation will help me buy more hardware.
- [Patreon](https://www.patreon.com/luigifcruz)
- [Buy Me a Coffee](https://www.buymeacoffee.com/luigi)
- [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TAA65AJMC7498&source=url)
### Support
Feel free to hit me up on [Twitter](https://twitter.com/luigifcruz) or [Email](mailto:luigifcruz@gmail.com) if your question isn't answered by this documentation. If you found a bug, please, report it directly on [GitHub Issues](https://github.com/luigifreitas/pisdr-image/issues).
### License
This project is distributed by an [GPL-2.0 License](/LICENSE).
### Disclaimer
This project isn't in any way associated with the Raspberry Pi Foundation.
### Contributing
Everyone is very welcome to contribute to our project.

8
apps/README.md 100644
Wyświetl plik

@ -0,0 +1,8 @@
# Pico Apps
These are sample applications with various purposes.
- [PiccoloSDR](/apps/piccolosdr): A primited direct-sampling SDR.
- [ADC DMA Chain](/apps/adc_dma_chain): Chained DMA data acquisition from the ADC.
- [Barometer](/apps/barometer): Barometer polling the temperature and atmospheric pressure from a BMP180.
- [Iperf Server](/apps/iperf_server): A tool to measure the performance of the TinyUSB's TCP/IP stack over USB.
- [TCP Server](/apps/tcp_server): A TCP server example to send high-frequency data to the host computer.

Wyświetl plik

@ -1,4 +1,4 @@
# IPERF Server
# Iperf Server
This is a tool to measure the network performance using `iperf2`. This program will make the Pico work like a network router when the device is plugged into a computer USB port using the RNDIS protocol. This was tested on Linux. This example will also create a sample HTTP page on 192.168.7.1.
### Dependencies

Wyświetl plik

@ -2,8 +2,8 @@
This example is a Raspberry Pico RP2040 working as a basic direct-sampling SDR. The data is sent via USB using the RNDIS protocol to emulate a TCP/IP interface. The ADC speed is limited to 500 ksps. This was tested on Linux but should work fine on Windows. The data can be used with software like the GNU Radio, an example is available [here](/apps/piccolosdr/piccolosdr.grc). It requires an OOT module that can be found [here](https://github.com/ghostop14/gr-grnet).
### Specifications
- 500 ksps Sample-rate
- 250 kHz Bandwidth
- 500 ksps sample-rate
- 250 kHz bandwidth
### Dependencies Device
- Patched `pico-sdr` and `pico-extras`.

11
lib/README.md 100644
Wyświetl plik

@ -0,0 +1,11 @@
# Pico Libraries
These are libraries to make things easier or add support for some sensor.
- [BMP180](/lib/bmp1880): Header-only library for the BMP180 atmospheric pressure sensor.
## Debug
For debug add `#define DEBUG` before the `#include` of a header-only library.
## Usage
Q: How can I use these libraries on my project?
A: Just copy and paste the header-only library file to your project.