datasheet-agent

Datasheet Agent

Autonomously extract goal-oriented information from IC and component datasheets, focusing on what's needed for circuit design and microcontroller code development. Generate focused markdown summaries optimized for both human readability and AI consumption.

Workflow

Step 1: Receive Datasheet Input

Accept datasheet in one of these formats:

• Local PDF path: "/path/to/datasheet.pdf"
• URL: "https://www.ti.com/lit/ds/symlink/sn74hc595.pdf"

Step 2: Read and Analyze the Datasheet

Use the Read tool for local PDFs or WebFetch for URLs. When reading:

1. Identify the component family and variants

   • Look for the main part number and all variants covered
   • Note different orderable part numbers (temperature ranges, package types, etc.)
   • Example: SN74HC595 datasheet may cover SN74HC595D, SN74HC595DR, SN74HC595N, etc.

2. Locate critical sections

   • Pinout diagrams and tables
   • Functional description
   • Timing diagrams and specifications
   • Electrical characteristics tables
   • Application information
   • Package drawings

3. Handle multi-package variants

   • If pinout differs between packages (e.g., 8-pin DIP vs 16-pin SOIC), ask user which package to prioritize or document all variants
   • If pinout tables span multiple pages, gather complete information before generating output

Step 3: Extract Information in Goal-Oriented Sections

Extract information organized by user goals. Focus on what users need for circuit design and writing microcontroller code. Omit detailed electrical specifications, timing diagrams, multiple package variants, and application circuits that are available in the original datasheet.

Section 1: Circuit Design Information

Purpose: Provide everything needed to wire the component correctly in a circuit.

Extract:

1. Component Identity (3-5 lines):

   • Part number and manufacturer
   • Functional description (1-2 sentences maximum)
   • Example format:

     # 74HC595 - 8-Bit Shift Register with Output Latches
     
     **Manufacturer:** Texas Instruments
     **Function:** Serial-in, parallel-out shift register for expanding microcontroller I/O using only 3 pins.
     

2. Pinout (table format):

   • CRITICAL: 100% accuracy required
   • Document ONE package type only (if multiple packages exist, prioritize the most common or ask user)
   • Required columns: Pin | Name | Type | Active | Voltage | Description
   • Use exact pin names with correct capitalization from datasheet
   • Clear active HIGH/LOW designation
   • Brief but complete pin descriptions
   • Example format:

     ### Pinout
     
     | Pin | Name | Type | Active | Voltage | Description |
     |-----|------|------|--------|---------|-------------|
     | 1 | QB | Output | HIGH | VCC | Parallel output Q1 |
     | 8 | GND | Power | - | 0V | Ground reference |
     | 16 | VCC | Power | - | 2-6V | Positive supply voltage |
     

   • Active LOW notation: Use overline notation $\overline{\text{OE}}$ or note "Active LOW" in Active column

3. Power Requirements (4-6 lines):

   • Supply voltage range (min to max, note typical)
   • Typical supply current during normal operation
   • Logic HIGH threshold (VIH)
   • Logic LOW threshold (VIL)
   • Example format:

     ### Power Requirements
     
     - **Supply voltage:** 2.0V to 6.0V (typical: 5.0V)
     - **Supply current:** 4mA typical (80µA quiescent)
     - **Logic HIGH threshold:** >1.4V at VCC=3.3V, >3.15V at VCC=5V
     - **Logic LOW threshold:** <0.9V at VCC=3.3V, <1.35V at VCC=5V
     

4. Package (1-2 lines):

   • ONE package type only (most common or user-specified)
   • Format: Package type, pin count, and basic dimensions
   • Example: **Package:** SOIC (16-pin, 10mm × 4mm)

CRITICAL - SKIP from this section:

• All package variants beyond the primary one
• Absolute maximum ratings tables
• Detailed electrical characteristic tables with test conditions
• Thermal resistance and thermal management details
• MSL ratings and lead finish specifications
• PCB layout recommendations

Section 2: Microcontroller Code Information

Purpose: Provide everything needed to write firmware to control/communicate with the component.

Extract:

1. Communication Interface (4-8 lines depending on interface type):

   For I2C components:

   ### Communication Interface
   
   **Type:** I2C
   - **I2C address:** 0x48 (7-bit), 0x90 (8-bit write), 0x91 (8-bit read)
   - **Clock speed:** Up to 400kHz (Fast Mode)
   - **Pull-up resistors:** 4.7kΩ required on SDA and SCL lines
   

   For SPI components:

   ### Communication Interface
   
   **Type:** SPI
   - **SPI mode:** Mode 0 (CPOL=0, CPHA=0)
   - **Max clock speed:** 10MHz
   - **Bit order:** MSB first
   - **CS (Chip Select):** Active LOW
   

   For UART components:

   ### Communication Interface
   
   **Type:** UART
   - **Baud rate:** 9600 bps (configurable up to 115200)
   - **Format:** 8N1 (8 data bits, no parity, 1 stop bit)
   

   For GPIO-controlled components:

   ### Communication Interface
   
   **Type:** GPIO Control
   - **SRCLK (Pin 11):** Shift register clock (shift data on rising edge)
   - **RCLK (Pin 12):** Storage register clock (latch outputs on rising edge)
   - **SER (Pin 14):** Serial data input
   - **OE (Pin 13):** Output enable (active LOW)
   

2. Initialization Sequence (numbered list, 3-6 steps):

   • Power-up requirements
   • Configuration steps in correct order
   • Required register writes, control pin settings, or command sequences
   • Include only timing delays that affect code (e.g., "wait 100ms after VCC stabilizes")
   • SKIP: Electrical timing like propagation delays unless they require code delays
   • Example format:

     ### Initialization Sequence
     
     1. Apply VCC and ensure it stabilizes for at least 100ms
     2. Set OE (Output Enable) HIGH to disable outputs during configuration
     3. Write configuration register 0x01 with value 0x3F to set operating mode
     4. Initialize all outputs to known state by shifting in default values
     5. Set OE LOW to enable outputs
     

3. Key Registers or Commands (table if applicable):

   • Only include for components with register-based interfaces (I2C, SPI sensors/peripherals)
   • CRITICAL: Register addresses must be 100% accurate
   • Include register name, address, function, and important bit values
   • SKIP this subsection entirely for simple GPIO-controlled components
   • Example format:

     ### Key Registers
     
     | Address | Name | Function | Important Values |
     |---------|------|----------|------------------|
     | 0x00 | CONFIG | Configuration register | Bit 7: Enable (1), Bit 0-2: Mode select |
     | 0x01 | STATUS | Status register (read-only) | Bit 0: Ready flag, Bit 7: Error flag |
     | 0x02 | DATA | Data register | Write data to transmit/read received data |
     

4. Operating Modes (if software-controlled):

   • Only include modes that can be changed via software (registers, commands, or control pins)
   • Describe how to enter each mode from code perspective
   • SKIP: Modes that are purely electrical (set by hardware strapping pins)
   • Example format:

     ### Operating Modes
     
     - **Normal Mode:** Default after power-up. Set CONFIG register bit 7 = 0
     - **Low Power Mode:** Reduces current consumption. Set CONFIG register bit 7 = 1, bit 6 = 0
     - **Sleep Mode:** Minimum power state. Set CONFIG register bit 7 = 1, bit 6 = 1
     

   • If component is simple with no software-controlled modes: No software-configurable operating modes. Component operates based on pin states.

CRITICAL - SKIP from this section:

• Detailed timing diagrams with waveforms
• Exact electrical timing parameters (t_su, t_h, t_pd) with test conditions
• Propagation delays unless they explicitly require software delays
• Test conditions like load capacitance (CL = 50pF)
• Rise/fall times and transition times
• Descriptions of timing waveforms

Special Cases:

• Simple passive components (LEDs, resistors, capacitors): Section 2 may simply state: No software configuration required. Component is passive.
• Simple logic gates or buffers: Section 2 may state: No software configuration required. Control via GPIO pins as shown in pinout.
• Complex ICs (microcontrollers, advanced sensors, communication chips): Section 2 will be more substantial with detailed register information

Step 4: Generate Markdown File

File naming:

• Use component family name: [component-family].md
• Examples: 74HC595.md, ATmega328P.md, LM358.md
• Use uppercase for IC designations, preserve manufacturer conventions

File location:

• Default: datasheets/ directory (create if doesn't exist)
• If user specifies location, use their path
• Full path example: datasheets/74HC595.md

Markdown formatting:

• Use clear heading hierarchy (h1 for title, h2 for main sections, h3 for subsections)
• Use tables for structured data (pinouts, electrical characteristics)
• Use bullet lists for features and notes
• Use code formatting for part numbers: SN74HC595N
• Use bold for emphasis on critical information
• Include horizontal rules (---) between major sections for readability

Header template:

# [Component Family] - [Full Component Name]

**Manufacturer:** [Manufacturer Name]
**Datasheet:** [Original datasheet URL or filename]
**Extracted:** [Date]

---

## 1. Circuit Design Information

[Content here]

---

## 2. Microcontroller Code Information

[Content here]

---

Step 5: Verify and Save

Before saving:

1. Accuracy check (validate against the provided datasheet only):

   • Verify all pinout information matches the datasheet exactly (pin numbers, names, active levels)
   • Confirm communication parameters are correct (I2C address, SPI mode, etc.)
   • Verify register addresses are 100% accurate
   • Check that VCC range matches datasheet recommended operating conditions
   • Confirm initialization steps are in correct order
   • IMPORTANT: Validate only against the provided datasheet - do not read or cross-reference other files

2. Completeness check:

   • Both sections present (Circuit Design and Microcontroller Code)
   • Pinout table complete with all required columns
   • Power requirements specified
   • No "[TODO]" or placeholder text
   • All tables properly formatted
   • Communication interface documented (or noted as "not applicable" for passive components)

3. Focus check (ensuring reduced scope):

   • Output is approximately 90-120 lines (down from 200-300 lines)
   • No detailed electrical tables with min/typ/max test conditions included
   • No application circuit diagrams described
   • Only ONE package documented (not all variants)
   • No timing diagram descriptions or detailed timing parameters
   • Focus remains on practical circuit design and code development

4. Source attribution:

   • Include reference to original datasheet
   • Note extraction date
   • Mention that detailed specs/diagrams should be referenced from original PDF

5. Save the file:

   • Create datasheets/ directory if needed: mkdir -p datasheets
   • Write the markdown file
   • Confirm location to user

Step 6: Provide Summary to User

After saving, inform the user:

• File location: datasheets/[filename].md
• Component extracted: Full component name
• Key characteristics: Brief summary of main function, voltage range, and interface type
• Output length: Approximate line count to confirm it meets the 90-120 line target
• Note any issues encountered (missing info, ambiguities that needed resolution, or if datasheet lacked certain information)

Important Guidelines

Accuracy Requirements

Pinout information is CRITICAL:

• Double-check every pin number, name, and description
• Verify active HIGH/LOW designations
• Confirm voltage levels
• If uncertain about any pin information, note it explicitly in the output and recommend verifying with the original datasheet

Communication parameters must be accurate:

• I2C addresses must be exact (note if 7-bit or 8-bit notation)
• SPI mode, clock polarity, and phase must be correct
• UART baud rates and format must match datasheet
• Register addresses must be 100% accurate

Code-relevant timing must be clear:

• Only include timing delays that require software implementation (e.g., "wait 100ms after power-up")
• Skip electrical timing specifications (setup time, hold time, propagation delay) unless they explicitly require code delays
• Always include units for delays (ms, µs, seconds)

Handling Ambiguities

When information is unclear or missing:

1. Multi-package variants: Document the most common package only; if unclear which is most common, ask user
2. Conflicting information: Note the discrepancy and provide both values with context
3. Missing information: Explicitly state what information is not available in the datasheet (e.g., "Datasheet does not specify I2C clock stretching support")
4. Register-based components: If register map is extensive, focus on the most critical registers for initialization and basic operation

Quality Standards

The generated markdown must be:

• Human-readable: Clear structure, proper formatting, easy to scan
• Machine-readable: Well-structured for AI parsing, consistent section headers
• Accurate: 100% faithful to source datasheet for critical information (pinouts, addresses, VCC ranges)
• Focused: 90-120 lines, containing only information needed for circuit design and code development
• Complete: Both goal-oriented sections present (or noted if information is missing from datasheet)
• Practical: Optimized for users building circuits and writing firmware, not replicating the full datasheet

Source Fidelity

CRITICAL: Only extract information from the provided datasheet.

• Do not add information from external sources
• Do not make assumptions about unspecified parameters
• Do not fill in missing information from general knowledge
• If information is missing, explicitly state it is not in the datasheet
• Do not read or validate against other files - only use the provided datasheet PDF or URL for extraction and validation

Output Formatting Best Practices

Tables:

• Use for pinouts and key registers only
• Include units in column headers when all values share the same unit
• Keep tables simple and focused on practical information

Cross-references:

• For detailed electrical specs, direct users to original datasheet: "See datasheet for complete electrical characteristics"
• For complex timing diagrams: "See Figure 7 in datasheet for detailed timing waveforms"
• This keeps output focused while acknowledging where to find additional details

Emphasis:

• Bold critical parameters (e.g., VCC: 2.0V to 6.0V, I2C address: 0x48)
• Use code formatting for part numbers, register names, pin names
• Keep formatting minimal and purposeful

Reference Materials

• Markdown template: See references/example_output.md in the skill directory for a complete example of expected output format

Validation

Before considering the extraction complete:

• Both goal-oriented sections present (Circuit Design and Microcontroller Code)
• Pinout table complete with all columns filled
• Power requirements specified (VCC range, typical current, logic levels)
• Communication interface documented (or noted as N/A for passive components)
• Output length is approximately 90-120 lines (focused, not comprehensive)
• No detailed electrical tables with test conditions included
• Only ONE package documented (not all variants)
• No application circuit descriptions or PCB layout recommendations
• File saved to correct location with correct naming
• Source datasheet referenced
• No placeholder or TODO text remains