Skip to content

Commit afe6c31

Browse files
author
GitHub Actions
committed
Update documentation from PULSAR C6 to PULSAR H2
- Updated all references from ESP32-C6 to ESP32-H2 throughout documentation - Corrected technical specifications for ESP32-H2 microcontroller - Updated ADC pin mapping with 5 functional channels (GPIO1, GPIO2, GPIO3, GPIO4, GPIO5) - Configured I2C pins for GPIO12 and GPIO22 - Updated SPI and microSD pin assignments (GPIO0, GPIO4, GPIO5, GPIO25) - Added comprehensive PULSAR H2 board specifications - Removed Wi-Fi references (ESP32-H2 supports Bluetooth LE, Zigbee, Thread only) - Updated power management and connectivity features - Cleaned up redundant architecture documentation
1 parent 128a6ad commit afe6c31

File tree

112 files changed

+4230
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+4230
-1
lines changed

‎.github/workflows/build_docs.yml‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
name: Build and Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: write
12+
13+
jobs:
14+
build-doc:
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- name: Checkout repository
19+
uses: actions/checkout@v4
20+
21+
- name: Set up Python
22+
uses: actions/setup-python@v5
23+
with:
24+
python-version: '3.10'
25+
26+
- name: Install dependencies (Python + LaTeX + Ghostscript)
27+
run: |
28+
sudo apt-get update
29+
sudo apt-get install -y texlive-latex-extra texlive-fonts-recommended texlive-lang-english ghostscript latexmk
30+
pip install -r software/documentation/requirements.txt
31+
pip install -r software/sphinx/requirements.txt
32+
33+
34+
- name: Copy and rename hardware images for documentation
35+
run: |
36+
mkdir -p software/documentation/images
37+
38+
# Buscar y copiar dimension
39+
file=$(ls hardware/resources/unit_dimension_*.png 2>/dev/null | head -n1)
40+
if [ -n "$file" ]; then cp "$file" software/documentation/images/dimension.png; else echo "dimension not found"; fi
41+
42+
# Buscar y copiar pinout
43+
file=$(ls hardware/resources/unit_pinout_*.png 2>/dev/null | head -n1)
44+
if [ -n "$file" ]; then cp "$file" software/documentation/images/pinout.png; else echo "pinout not found"; fi
45+
46+
# Buscar y copiar top
47+
file=$(ls hardware/resources/unit_top_*.png 2>/dev/null | head -n1)
48+
if [ -n "$file" ]; then cp "$file" software/documentation/images/top.png; else echo "top not found"; fi
49+
50+
51+
#################################################
52+
# Generar PDF del Product Brief con nombre del repo
53+
#################################################
54+
- name: Build LaTeX PDF from README
55+
working-directory: software/documentation
56+
env:
57+
REPO_NAME: ${{ github.event.repository.name }}
58+
run: |
59+
python test_readme.py
60+
python generate_pdf.py
61+
gs -sDEVICE=pdfwrite -dCompatibilityLevel=1.4 -dPDFSETTINGS=/printer \
62+
-dNOPAUSE -dQUIET -dBATCH \
63+
-sOutputFile=build/${REPO_NAME}_product_brief.pdf build/*.pdf
64+
65+
#################################################
66+
# Generar Documentación Sphinx (HTML + PDF)
67+
#################################################
68+
- name: Build Sphinx Documentation
69+
working-directory: software/sphinx
70+
run: |
71+
make clean
72+
make pdfx
73+
74+
#################################################
75+
# Preparar contenido para docs/
76+
#################################################
77+
- name: Prepare docs/ directory
78+
env:
79+
REPO_NAME: ${{ github.event.repository.name }}
80+
run: |
81+
rm -rf docs
82+
mkdir -p docs
83+
84+
# PDF generado desde LaTeX
85+
cp software/documentation/build/${REPO_NAME}_product_brief.pdf docs/
86+
87+
# PDF generado por Sphinx
88+
cp software/sphinx/pdf/programmer.pdf docs/${REPO_NAME}_sphinx.pdf
89+
90+
# HTML generado por Sphinx
91+
cp -r software/sphinx/docs/* docs/
92+
93+
# Permitir archivos especiales en GitHub Pages
94+
touch docs/.nojekyll
95+
96+
#################################################
97+
# Publicar cambios a la rama main
98+
#################################################
99+
- name: Commit and push docs/ to main
100+
if: github.ref == 'refs/heads/main'
101+
run: |
102+
git config --global user.name "GitHub Actions"
103+
git config --global user.email "actions@github.com"
104+
git pull origin main
105+
git add docs/
106+
git commit -m "Deploy full documentation and product brief [skip ci]" || echo "No changes"
107+
git push origin main

‎.gitignore‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
software/documentation/venv/*
3+
software/venv/*
4+
venv
5+
software/documentation/build
6+
software/documentation/docs
7+
software/getting_started/docs
8+
software/getting_started/pdf
9+
software/sphinx/build
10+
software/sphinx/html
11+
software/sphinx/latex
12+
software/sphinx/pdf
13+
software/sphinx/docs
14+
software/sphinx/pdf
15+
software/venv
16+
software/firmware

‎README.md‎

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,41 @@
1-
![UNIT PULSAR ESP32 H2 V1.0.0](resources/TOP_1v0.png)
1+
# UNIT PULSAR ESP32 H2 Development Board
2+
3+
4+
The **UNIT PULSAR ESP32 H2** is a cutting-edge development board designed for IoT applications, leveraging the powerful ESP32 H2 microcontroller. Inspired by the arduino nano form factor, this board is perfect for developers looking to create compact and efficient solutions.
5+
6+
<div align="center">
7+
<img src="hardware/resources/TOP_1v0.png" alt="UNIT PULSAR ESP32 H2 V1.0.0" width="100"/>
8+
</div>
9+
10+
11+
<div align="center">
12+
13+
### Quick Setup
14+
15+
[<img src="https://img.shields.io/badge/Product%20Wiki-blue?style=for-the-badge" alt="Product Wiki">](#)
16+
[<img src="https://img.shields.io/badge/Datasheet-green?style=for-the-badge" alt="Datasheet">](#)
17+
[<img src="https://img.shields.io/badge/Buy%20Now-orange?style=for-the-badge" alt="Buy Now">](https://uelectronics.com/)
18+
[<img src="https://img.shields.io/badge/Getting%20Started-purple?style=for-the-badge" alt="Getting Started">](#)
19+
20+
</div>
221

322
We are currently working on the design of this new development board, **UNIT PULSAR ESP32 H2**, at UNIT Electronics. Stay tuned for upcoming updates, including the schematic and future iterations. Our goal is to provide comprehensive resources that support the use and development with the UNIT PULSAR ESP32 H2.
423

524
---
625

726
For more details and updates, make sure to follow this repository and check back regularly!
827

28+
### Features
29+
30+
## Applications
31+
32+
## Resources
33+
34+
935
## License
1036

1137
This project is licensed under the **MIT License**. For more details, please refer to the LICENSE file in this repository.
1238

39+
<div align="center">
40+
<sub>Template created by UNIT Electronics </sub>
41+
</div>

‎docs/.gitkeep‎

Whitespace-only changes.

‎resources/BOTTOM_1v0.png‎ renamed to ‎hardware/resources/BOTTOM_1v0.png‎

File renamed without changes.

‎resources/TOP_1v0.png‎ renamed to ‎hardware/resources/TOP_1v0.png‎

File renamed without changes.

‎software/documentation/LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Cesar
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎software/documentation/README.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
---
2+
title: "Touchdot S3 Development Board"
3+
version: "1.0"
4+
modified: "2025-04-23"
5+
output: "touchdot_s3_development_board"
6+
subtitle: "Compact ESP32-S3 mini microcontroller development board inspired by Lilypad. Ideal for IoT, control systems, and creative electronics projects."
7+
---
8+
9+
<!--
10+
# README_TEMPLATE.md
11+
Este archivo sirve como entrada para generar un PDF técnico estilo datasheet.
12+
Edita las secciones respetando el orden, sin eliminar los encabezados.
13+
-->
14+
15+
# ESP32-S3 Development Board
16+
17+
![product](../../hardware/resources/unit_top_V_0_1_2_ue0072_Touch-Dot-S3.png)
18+
19+
## Introduction
20+
The Unit Touchdot S3 is a compact ESP32-S3 Mini board designed for wearable electronics, IoT devices, educational projects, and smart automation. Its Lilypad-inspired, low-profile, sewable design makes it perfect for integrating into textiles and compact enclosures while providing advanced wireless and processing capabilities.
21+
22+
Equipped with 2.4 GHz Wi-Fi, Bluetooth 5.0, and a modern interface featuring a USB-C connector, onboard LiPo charging, and a QWIIC I²C port, the board supports rapid prototyping and creative development. It offers a robust platform bridging wearable design and embedded computing, tailored for students, makers, and engineers.
23+
24+
## Functional Description
25+
26+
- Integrated ESP32-S3 module with 2.4 GHz Wi-Fi and Bluetooth 5.0
27+
- USB-C connector for power and programming
28+
- 3.3V power rail compatible with low-voltage peripherals
29+
- Built-in QWIIC connector for easy I²C module integration
30+
- Micro SD card slot using SPI interface
31+
- Onboard NeoPixel (WS2812) RGB LED
32+
33+
## Electrical Characteristics & Signal Overview
34+
35+
- Operating voltage: 3.3V
36+
- Max current draw: 500mA (with Wi-Fi active)
37+
- GPIO logic level: 3.3V
38+
- ADC resolution: 12-bit (0–4095)
39+
- Touchpad sensitivity: configurable
40+
41+
## Applications
42+
43+
- Wearable electronics
44+
- IoT sensor nodes
45+
- Smart home and automation
46+
- Educational tools for STEM (science, technology, engineering, and mathematics)
47+
- Environmental monitoring
48+
- Creative electronics and art-tech installations
49+
- Smart Home
50+
- Health Care
51+
52+
53+
## Pin & Connector Layout
54+
55+
| Group | Availables pins | Suggested use |
56+
|-----------|-----------------|----------------------------------------|
57+
| GPIO | D2 to D13 | Sensors, actuators |
58+
| UART | Tx and Rx | Serial communication |
59+
| TouchPad | T1 to T11 | Capacitive sensors for touch detection |
60+
| Analog | A0 to A8 | 12-bit (0–4095) resolution |
61+
| SPI | Optional | Displays, additional memory |
62+
63+
## Settings
64+
65+
### Interface Overview
66+
67+
### Interface Overview
68+
69+
| Interface | Signals / Pins | Typical Use |
70+
|-----------|------------------|---------------------------------------------|
71+
| UART | TX (GPIO17) | Serial transmit (TX) |
72+
| UART | RX (GPIO16) | Serial receive (RX) |
73+
| I2C | SDA (GPIO5) | I²C data line (QWIIC, OLED, sensors) |
74+
| I2C | SCL (GPIO6) | I²C clock line |
75+
| SPI | MOSI (GPIO9) | Data to SPI device |
76+
| SPI | MISO (GPIO8) | Data from SPI device |
77+
| SPI | SCK (GPIO13) | SPI clock signal |
78+
| SPI | CS (GPIO21) | Chip select for SPI device |
79+
| USB | D+ (GPIO20) | USB differential data (+) |
80+
| USB | D− (GPIO19) | USB differential data (−) |
81+
82+
83+
### Supports
84+
85+
| Symbol | I/O | Description |
86+
|----------|---------------|---------------------------------------------------|
87+
| USB -C | Input | USB-C connector for 5V power and data |
88+
| Li-ion/LiPo | Input | Connector for LiPo battery power (3.7V - 4.2V) |
89+
| VCC | Input | Main power supply (3.3V) |
90+
| GND | Ground | Ground connection |
91+
| IO | Bidirectional | General-purpose I/O pins |
92+
| NeoPixel | Output GPIO25 | WS2812 RGB LED data output |
93+
94+
## Block Diagram
95+
96+
![Function Diagram](../../hardware/resources/unit_pinout_top_v_0_2_0_ue0072_touch_dot_s3_en.png)
97+
98+
![Function Diagram](../../hardware/resources/unit_pinout_bottom_v_0_2_0_ue0072_touch_dot_s3_en.png)
99+
100+
## Dimensions
101+
102+
![Dimensions](../../hardware/resources/unit_dimension_V_0_1_2_ue0072_Touch-Dot-S3.png)
103+
104+
## Usage
105+
106+
Works with:
107+
108+
- Arduino IDE (ESP32 board manager)
109+
- ESP-IDF toolchain
110+
- MicroPython firmware
111+
- CircuitPython (via UF2 bootloader)
112+
113+
## Downloads
114+
115+
- [Schematic PDF](https://github.com/UNIT-Electronics-MX/unit_touchdot_s3/tree/main/hardware#hardware)
116+
- [Board Dimensions](https://github.com/UNIT-Electronics-MX/unit_touchdot_s3/tree/main/hardware#dimensions)
117+
- [Pinout Diagram PNG](https://github.com/UNIT-Electronics-MX/unit_touchdot_s3/tree/main/hardware#pinout)
118+
119+
## Purchase
120+
121+
- [Buy from UNIT Electronics](https://www.uelectronics.com)
122+
- [Open product page](https://github.com/UNIT-Electronics-MX/unit_touchdot_s3/tree/main)
123+

0 commit comments

Comments
 (0)