@embedder/embedder 2.0.33 → 2.0.34
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,84 +1,55 @@
|
|
|
1
|
-
# Embedder
|
|
1
|
+
# Embedder
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
 [![npm]](https://www.npmjs.com/package/@embedder/embedder)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
[npm]: https://img.shields.io/npm/v/@embedder/embedder.svg?style=flat-square
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Embedder is an AI coding tool that lives in your terminal, specializing in embedded software development. It understands your hardware, indexes datasheets and reference manuals, and helps you write and test firmware faster by executing routine tasks, debugging on real hardware, and handling complex peripheral configurations.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
**Learn more in the [official documentation](https://docs.embedder.dev)**.
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
npm install -g @embedder/embedder
|
|
13
|
-
```
|
|
11
|
+
## Get started
|
|
14
12
|
|
|
15
|
-
|
|
13
|
+
1. Install Embedder:
|
|
16
14
|
|
|
17
|
-
```
|
|
18
|
-
embedder
|
|
15
|
+
```sh
|
|
16
|
+
npm install -g @embedder/embedder
|
|
19
17
|
```
|
|
20
18
|
|
|
21
|
-
|
|
19
|
+
2. Navigate to your project directory and run `embedder`.
|
|
22
20
|
|
|
23
21
|
## What Makes Embedder Different
|
|
24
22
|
|
|
25
|
-
Embedder
|
|
23
|
+
Embedder is built specifically for embedded systems:
|
|
26
24
|
|
|
27
|
-
- **Hardware-Aware**: Understands microcontroller peripherals, memory constraints, and real-time requirements
|
|
25
|
+
- **Hardware-Aware**: Understands microcontroller peripherals (GPIO, SPI, I²C, UART, ADC, DMA, timers, interrupts), memory constraints, and real-time requirements
|
|
28
26
|
- **Documentation Intelligence**: Indexes datasheets, reference manuals, and schematics to generate code based on your actual hardware specs
|
|
29
27
|
- **Real Hardware Integration**: Connects with serial ports, debuggers, logic analyzers, and oscilloscopes to validate and debug on physical devices
|
|
30
|
-
- **Embedded Expertise**: Deep knowledge of
|
|
31
|
-
|
|
32
|
-
## Core Capabilities
|
|
33
|
-
|
|
34
|
-
### Analysis & Planning
|
|
35
|
-
- Requirements analysis and task breakdown
|
|
36
|
-
- System architecture design considering microcontroller peripherals
|
|
37
|
-
- Dependency mapping and integration planning
|
|
38
|
-
- Risk assessment for hardware constraints, timing, and memory
|
|
28
|
+
- **Embedded Expertise**: Deep knowledge of RTOS systems, low-level driver development, and MISRA-C/C++ compliance
|
|
39
29
|
|
|
40
|
-
|
|
41
|
-
- Peripheral programming (GPIO, SPI, I²C, UART, ADC, DMA, Timers, Interrupts)
|
|
42
|
-
- Memory management and optimization (RAM/Flash)
|
|
43
|
-
- Real-time systems and RTOS integration
|
|
44
|
-
- Low-level driver development and HAL layers
|
|
45
|
-
|
|
46
|
-
### Code Quality & Standards
|
|
47
|
-
- MISRA-C/C++ compliance
|
|
48
|
-
- Performance, memory, and power optimization
|
|
49
|
-
- Static analysis and code review
|
|
50
|
-
- Datasheet analysis and hardware specification verification
|
|
51
|
-
|
|
52
|
-
### Hardware Validation
|
|
53
|
-
- Serial port monitoring and debugging
|
|
54
|
-
- GDB debugger integration
|
|
55
|
-
- Logic analyzer and oscilloscope integration
|
|
56
|
-
- Autonomous issue detection and fixing
|
|
30
|
+
## Supported Platforms
|
|
57
31
|
|
|
58
|
-
|
|
32
|
+
Works with any embedded platform including ESP32, STM32, nRF, Raspberry Pi Pico, Arduino, and more. Compatible with all major toolchains including GCC, IAR, Keil, and vendor-specific compilers.
|
|
59
33
|
|
|
60
|
-
|
|
34
|
+
## Connect on Discord
|
|
61
35
|
|
|
62
|
-
|
|
36
|
+
Join the [Embedder Discord](https://discord.com/invite/NMT5ndEyxk) to connect with other embedded developers. Get help, share feedback, and discuss your projects with the community.
|
|
63
37
|
|
|
64
|
-
|
|
38
|
+
## Data collection, usage, and retention
|
|
65
39
|
|
|
66
|
-
|
|
40
|
+
When you use Embedder, we collect feedback, which includes usage data.
|
|
67
41
|
|
|
68
|
-
|
|
42
|
+
### How we use your data
|
|
69
43
|
|
|
70
|
-
|
|
71
|
-
-
|
|
72
|
-
-
|
|
73
|
-
-
|
|
74
|
-
- Raspberry Pi Pico
|
|
75
|
-
- Arduino
|
|
76
|
-
- And many more...
|
|
44
|
+
We use your data to:
|
|
45
|
+
- Provide and maintain our services
|
|
46
|
+
- Improve our services and develop new features
|
|
47
|
+
- Provide customer support and technical assistance
|
|
77
48
|
|
|
78
|
-
|
|
49
|
+
All codebase indexing happens locally on your machine. For cloud features, we offer enterprise agreements with strict data isolation and compliance with ITAR, ISO 27001, and other standards.
|
|
79
50
|
|
|
80
|
-
|
|
51
|
+
### Privacy safeguards
|
|
81
52
|
|
|
82
|
-
|
|
53
|
+
We have implemented several safeguards to protect your data, including limited retention periods for sensitive information, restricted access to user session data, and clear policies against using feedback for model training without consent.
|
|
83
54
|
|
|
84
|
-
|
|
55
|
+
For full details, please review our [Terms of Service](https://embedder.dev/terms-of-service) and [Privacy Policy](https://embedder.dev/privacy-policy).
|