diff --git a/mkdocs/education/actuators.md b/mkdocs/education/actuators.md new file mode 100644 index 00000000..cd470fb5 --- /dev/null +++ b/mkdocs/education/actuators.md @@ -0,0 +1,3 @@ +# Basics of Actuators + +Coming soon... diff --git a/mkdocs/education/adc.md b/mkdocs/education/adc.md new file mode 100644 index 00000000..127429ab --- /dev/null +++ b/mkdocs/education/adc.md @@ -0,0 +1,3 @@ +# ADC: Analog to Digital Converter + +Coming soon... diff --git a/mkdocs/education/architecture.md b/mkdocs/education/architecture.md new file mode 100644 index 00000000..174fdf35 --- /dev/null +++ b/mkdocs/education/architecture.md @@ -0,0 +1,3 @@ +# Microcontroller Architecture + +Coming soon... diff --git a/mkdocs/education/bitmasking.md b/mkdocs/education/bitmasking.md new file mode 100644 index 00000000..2708fa6f --- /dev/null +++ b/mkdocs/education/bitmasking.md @@ -0,0 +1,3 @@ +# The Art of Bit Masking + +Coming soon... diff --git a/mkdocs/education/canbus.md b/mkdocs/education/canbus.md new file mode 100644 index 00000000..f53e01c4 --- /dev/null +++ b/mkdocs/education/canbus.md @@ -0,0 +1,3 @@ +# CAN BUS: Controller Area Network Bus + +Coming soon... diff --git a/mkdocs/education/dac.md b/mkdocs/education/dac.md new file mode 100644 index 00000000..c15612cc --- /dev/null +++ b/mkdocs/education/dac.md @@ -0,0 +1,3 @@ +# DAC: Digital to Analog Convert + +Coming soon... diff --git a/mkdocs/education/dma.md b/mkdocs/education/dma.md new file mode 100644 index 00000000..c2895ebf --- /dev/null +++ b/mkdocs/education/dma.md @@ -0,0 +1,3 @@ +# DMA: Direct Memory Access + +Coming soon... diff --git a/mkdocs/education/embedded_systems.md b/mkdocs/education/embedded_systems.md new file mode 100644 index 00000000..6d1fa998 --- /dev/null +++ b/mkdocs/education/embedded_systems.md @@ -0,0 +1,3 @@ +# Introduction to Embedded Systems + +Coming soon... diff --git a/mkdocs/education/gpio.md b/mkdocs/education/gpio.md new file mode 100644 index 00000000..959997aa --- /dev/null +++ b/mkdocs/education/gpio.md @@ -0,0 +1,3 @@ +# GPIO: General Purpose Input/Output + +Coming soon... diff --git a/mkdocs/education/i2c.md b/mkdocs/education/i2c.md new file mode 100644 index 00000000..13ffd92c --- /dev/null +++ b/mkdocs/education/i2c.md @@ -0,0 +1,3 @@ +# I2C: Inter-Integrated Circuit + +Coming soon... diff --git a/mkdocs/education/pwm.md b/mkdocs/education/pwm.md new file mode 100644 index 00000000..b0d9156d --- /dev/null +++ b/mkdocs/education/pwm.md @@ -0,0 +1,3 @@ +# PWM: Pulse Width Modulation + +Coming soon... diff --git a/mkdocs/education/rtos.md b/mkdocs/education/rtos.md new file mode 100644 index 00000000..83a16549 --- /dev/null +++ b/mkdocs/education/rtos.md @@ -0,0 +1,3 @@ +# RTOS: Real time Operating Systems + +Coming soon... diff --git a/mkdocs/education/sensors.md b/mkdocs/education/sensors.md new file mode 100644 index 00000000..045972e3 --- /dev/null +++ b/mkdocs/education/sensors.md @@ -0,0 +1,3 @@ +# Basics of Sensors + +Coming soon... diff --git a/mkdocs/education/spi.md b/mkdocs/education/spi.md new file mode 100644 index 00000000..fe7fbb26 --- /dev/null +++ b/mkdocs/education/spi.md @@ -0,0 +1,3 @@ +# SPI: Serial Peripheral Interface + +Coming soon... diff --git a/mkdocs/education/tbd.md b/mkdocs/education/tbd.md new file mode 100644 index 00000000..c013de6f --- /dev/null +++ b/mkdocs/education/tbd.md @@ -0,0 +1,5 @@ +# To be determined + +This page is just a place holder for additional content. This +page will always be here because there will always be more +subjects to discuss when it comes to embedded systems. diff --git a/mkdocs/education/timers_and_counters.md b/mkdocs/education/timers_and_counters.md new file mode 100644 index 00000000..461342a0 --- /dev/null +++ b/mkdocs/education/timers_and_counters.md @@ -0,0 +1,3 @@ +# Timers & Counters + +Coming soon... diff --git a/mkdocs/education/uart.md b/mkdocs/education/uart.md new file mode 100644 index 00000000..bf0a1b15 --- /dev/null +++ b/mkdocs/education/uart.md @@ -0,0 +1,3 @@ +# UART: Universal Asynchronous Receiver/Transmitter + +Coming soon... diff --git a/mkdocs/summary.md b/mkdocs/summary.md index 1a164725..97d60e92 100644 --- a/mkdocs/summary.md +++ b/mkdocs/summary.md @@ -7,6 +7,24 @@ - [ðŸŽŊ Debugging Code with PyOCD](user_guide/debugging.md) - [ðŸŠĪ Error Handling in libhal](user_guide/error_handling.md) - [⚖ïļ Policies & FAQ](user_guide/policy.md) +- ðŸŦ Education + - [What are Embedded Systems?](education/embedded_systems.md) + - [Bit Masking](education/bitmasking.md) + - [Microcontroller Architecture](education/architecture.md) + - [General Purpose I/O](education/gpio.md) + - [DMA](education/dma.md) + - [Timers & Counters](education/timers_and_counters.md) + - [ADC](education/adc.md) + - [PWM](education/pwm.md) + - [SPI](education/spi.md) + - [UART](education/uart.md) + - [I2C](education/i2c.md) + - [DAC](education/dac.md) + - [CAN BUS](education/canbus.md) + - [Basics of Sensors](education/sensors.md) + - [Basics of Actuators](education/actuators.md) + - [RTOS](education/rtos.md) + - [TBD](education/tbd.md) - 📚 Contributor Guides - [📜 Design Philosophy](contributor_guide/philosophy.md) - [🗃ïļ Organization](contributor_guide/organization.md) diff --git a/mkdocs/user_guide/policy.md b/mkdocs/user_guide/policy.md index f1ace971..e5d4f998 100644 --- a/mkdocs/user_guide/policy.md +++ b/mkdocs/user_guide/policy.md @@ -49,12 +49,12 @@ and will handle them case-by-case. Currently, libhal steers clear of SDKs with confining licenses or those misaligned with Apache 2.0 or its equivalents. This includes licenses from NXP -and STM. However, SDKs from Espressif Systems (with Apache 2.0) are potentially -usable. +and STM. However, SDKs from Espressif Systems (with Apache 2.0) and Pico SDK +are potentially usable so long as they reach our quality bar. ## 5. **Dealing with Devices Lacking Public Manuals** -Devices without public user manuals typically don't get a libhal library. Here's +Devices without public user manuals will not get a libhal library. Here's why: 1. It risks unintentional exposure of proprietary device information. @@ -62,4 +62,5 @@ why: a reverse-engineering puzzle. We can craft drivers for such devices, but their source code would remain -confidential. Libhal predominantly focuses on fostering open-source libraries. +confidential. The libhal organization may perform such work on a contract basis +but such work would not make it to the open source ecosystem.