Added badges with version to the README files of components
This commit is contained in:
Daniel Paul
parent
2d3a9b3b87
commit
458086bb45
@ -1,5 +1,7 @@
|
||||
# Brushed DC Motor Control
|
||||
|
||||
[](https://components.espressif.com/components/espressif/bdc_motor)
|
||||
|
||||
This directory contains an implementation for Brushed DC Motor by different peripherals. Currently only MCPWM is supported as the BDC motor backend.
|
||||
|
||||
To learn more about how to use this component, please check API Documentation from header file [bdc_motor.h](./include/bdc_motor.h).
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
# Eigen for ESP-IDF
|
||||
|
||||
[](https://components.espressif.com/components/espressif/eigen)
|
||||
|
||||
This component ports Eigen library into the esp-idf.
|
||||
|
||||
**Eigen is a C++ template library for linear algebra: matrices, vectors, numerical solvers, and related algorithms.**
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
# ESP Encrypted Image Abstraction Layer
|
||||
|
||||
[](https://components.espressif.com/components/espressif/esp_encrypted_img)
|
||||
|
||||
This component provides an API interface to decrypt data defined in "ESP Encrypted Image" format. This format is as specified at [Image Format](#image-format)
|
||||
|
||||
This component can help in integrating pre encrypted firmware in over-the-air updates. Additionally, this component can also be used for other use-cases which requires addition of encryption layer for custom data.
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
# JPEG Decoder: TJpgDec - Tiny JPEG Decompressor
|
||||
|
||||
[](https://components.espressif.com/components/espressif/esp_jpeg)
|
||||
|
||||
TJpgDec is a generic JPEG image decompressor that is highly optimized for small embedded systems. It works with very low memory consumption.
|
||||
|
||||
Some microcontrollers have TJpg decoder in ROM, it is used, if there is. [^1] Using ROM code can be disabled in menuconfig.
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
# Espressif Serial Slave Link (ESSL) component
|
||||
|
||||
[](https://components.espressif.com/components/espressif/esp_serial_slave_link)
|
||||
|
||||
This component used to reside in [esp-idf](https://github.com/espressif/esp-idf) project as its component.
|
||||
|
||||
It's used on the HOST, to communicate with ESP chips as SLAVE via SDIO/SPI slave HD mode.
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
# FMT
|
||||
|
||||
[](https://components.espressif.com/components/espressif/fmt)
|
||||
|
||||
**fmt** is an open-source formatting library providing a fast and safe
|
||||
alternative to C stdio and C++ iostreams.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
JSMN
|
||||
====
|
||||
|
||||
[](https://travis-ci.org/zserge/jsmn)
|
||||
[](https://travis-ci.org/zserge/jsmn) [](https://components.espressif.com/components/espressif/jsmn)
|
||||
|
||||
jsmn (pronounced like 'jasmine') is a minimalistic JSON parser in C. It can be
|
||||
easily integrated into resource-limited or embedded projects.
|
||||
|
||||
@ -1,4 +1,7 @@
|
||||
# JSON Generator
|
||||
|
||||
[](https://components.espressif.com/components/espressif/json_generator)
|
||||
|
||||
A simple JSON (JavasScript Object Notation) generator with flushing capability.
|
||||
Details of JSON can be found at [http://www.json.org/](http://www.json.org/).
|
||||
The JSON strings generated can be validated using any standard JSON validator. Eg. [https://jsonlint.com/](https://jsonlint.com/)
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
# JSON Parser
|
||||
|
||||
[](https://components.espressif.com/components/espressif/json_parser)
|
||||
|
||||
This is a simple, light weight JSON parser built on top of [jsmn](https://github.com/zserge/jsmn).
|
||||
|
||||
Files
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
# LED Strip Component
|
||||
|
||||
[](https://components.espressif.com/components/espressif/led_strip)
|
||||
|
||||
This directory contains an implementation for addressable LEDs by different peripherals. Currently only RMT is supported as the led strip backend.
|
||||
|
||||
The driver should be compatible with:
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
# Simple PCAP file writer
|
||||
|
||||
[](https://components.espressif.com/components/espressif/pcap)
|
||||
|
||||
This component allows users to trace their captured packets in .pcap file format.
|
||||
|
||||
More details about PCAP format can be found [here](https://wiki.wireshark.org/Development/LibpcapFileFormat).
|
||||
|
||||
3
pid_ctrl/README.md
Normal file
3
pid_ctrl/README.md
Normal file
@ -0,0 +1,3 @@
|
||||
# Proportional integral derivative controller
|
||||
|
||||
[](https://components.espressif.com/components/espressif/pcap)
|
||||
@ -1,5 +1,7 @@
|
||||
# QR Code generator component
|
||||
|
||||
[](https://components.espressif.com/components/espressif/qrcode)
|
||||
|
||||
This component contains a QR code generator written in C. This component is based on [QR-Code-generator](https://github.com/nayuki/QR-Code-generator).
|
||||
This component is used as part of the following ESP-IDF examples:
|
||||
- [DPP Enrollee Example](https://github.com/espressif/esp-idf/tree/master/examples/wifi/wifi_easy_connect/dpp-enrollee).
|
||||
|
||||
@ -1,4 +1,6 @@
|
||||
# Abstraction layer for HTTP2 with TLS
|
||||
|
||||
[](https://components.espressif.com/components/espressif/sh2lib)
|
||||
|
||||
This component contains an abstraction layer which exposes simpler set of APIs combining `nghttp2` (HTTP/2 C Library) and `esp-tls` (from ESP-IDF) components.
|
||||
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
# USB DTE plugin for esp_modem
|
||||
|
||||
[](https://components.espressif.com/components/espressif/esp_modem_usb_dte)
|
||||
|
||||
> :warning: **Experimental feature**: USB DTE is under development!
|
||||
|
||||
This component extends [esp_modem](https://components.espressif.com/component/espressif/esp_modem) with USB DTE.
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
# Espressif's additions to TinyUSB
|
||||
|
||||
[](https://components.espressif.com/components/espressif/esp_tinyusb)
|
||||
|
||||
This component adds features to TinyUSB that help users with integrating TinyUSB with their ESP-IDF application.
|
||||
|
||||
It contains:
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
description: Espressif's additions to TinyUSB
|
||||
documentation: "https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/api-reference/peripherals/usb_device.html"
|
||||
version: 1.0.0
|
||||
url: https://github.com/espressif/idf-extra-components/tree/master/usb/esp_tinyusb
|
||||
dependencies:
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
# USB Host CDC-ACM Class Driver
|
||||
|
||||
[](https://components.espressif.com/components/espressif/usb_host_cdc_acm)
|
||||
|
||||
This directory contains an implementation of a USB CDC-ACM Host Class Driver that is implemented on top of the [USB Host Library](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/api-reference/peripherals/usb_host.html).
|
||||
|
||||
## Supported Devices
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
# CH34x USB-UART converter driver
|
||||
|
||||
[](https://components.espressif.com/components/espressif/usb_host_ch34x_vcp)
|
||||
|
||||
Limited implementation only. The vendor does not provide full specification.
|
||||
|
||||
* CH340 and CH341 supported
|
||||
|
||||
@ -1,4 +1,6 @@
|
||||
# Silicon Labs CP210x USB-UART converter driver
|
||||
|
||||
[](https://components.espressif.com/components/espressif/usb_host_cp210x_vcp)
|
||||
|
||||
* [Datasheet](https://www.silabs.com/documents/public/data-sheets/CP2102-9.pdf)
|
||||
* [Application note](https://www.silabs.com/documents/public/application-notes/an197.pdf)
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
# FTDI UART-USB converters driver
|
||||
|
||||
[](https://components.espressif.com/components/espressif/usb_host_ftdi_vcp)
|
||||
|
||||
Supported devices:
|
||||
* FT231
|
||||
* FT232
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
# USB Host MSC (Mass Storage Class) Driver
|
||||
|
||||
[](https://components.espressif.com/components/espressif/usb_host_msc)
|
||||
|
||||
This directory contains an implementation of a USB Mass Storage Class Driver implemented on top of the [USB Host Library](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/api-reference/peripherals/usb_host.html).
|
||||
|
||||
MSC driver allows access to USB flash drivers using the BOT “Bulk-Only Transport” protocol and the Transparent SCSI command set.
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
# USB Host UVC Driver
|
||||
|
||||
[](https://components.espressif.com/components/espressif/usb_host_uvc)
|
||||
|
||||
This directory contains USB host UVC driver based on [libuvc](https://github.com/libuvc/libuvc) library. Support for `libuvc` is achieved by implementing adapter between [libusb](https://github.com/libusb/libusb) (underling host library used by `libuvc`) and [usb_host](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/api-reference/peripherals/usb_host.html) library targeted for ESP SOCs.
|
||||
|
||||
## Usage
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
# Virtual COM Port Service
|
||||
|
||||
[](https://components.espressif.com/components/espressif/usb_host_vcp)
|
||||
|
||||
Virtual COM Port (VCP) service manages drivers to connected VCP devices - typically USB <-> UART converters.
|
||||
In practice, you rarely care about specifics of the devices; you only want uniform interface for them all.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user