Skip to content

Commit 612d354

Browse files
codekilncodekiln
committed
docs: Add USB connector documentation and reference index
- Created detailed documentation for USB connector types including USB-A, USB-B, and USB-C, outlining specifications, compatibility, and common use cases. - Developed a USB Connector Reference Index for quick access to connector types and their specifications. - Introduced a USB Connector Documentation Plan to structure future documentation efforts and ensure consistency across the knowledge base. - Added new journal entries related to Raspberry Pi and Rust, enhancing the overall content related to these topics.
1 parent e86e142 commit 612d354

8 files changed

+597
-0
lines changed

‎journals/2025_12_14.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
- [[Rust]]
2+
- downloaded [[JetBrains/RustRover]] to try out for the first time, at a recommendation from a colleague.
3+
- [[Read/ing]]
4+
- [The Information: A History, a Theory, a Flood - Wikipedia](https://en.wikipedia.org/wiki/The_Information:_A_History,_a_Theory,_a_Flood)
5+
- Ordered
6+
- [Annette Vande Gorne: Treatise on Writing Acousmatic Music on Fixed Media (Book) – LIEN 2018](https://electrocd.com/en/album/5929-treatise-on-writing-acousmatic-music-on-fixed-media)
7+
- [[RaspberryPi/Zero/2w]]

‎pages/Adafruit___Understanding USB Type C - Cable Types Pitfalls etc.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# [Cable Types and Differences | Understanding USB Type C: Cable Types, Pitfalls and More | Adafruit Learning System](https://learn.adafruit.com/understanding-usb-type-c-cable-types-pitfalls-and-more/cable-types-and-differences)
2+
- Related: [[USB/Connector/Ref/USB-C]] | [[USB/Connector/Ref/Index]]
23
- ![USB-C types](https://cdn-learn.adafruit.com/assets/assets/000/085/324/large1024/components_adafruit_USB_C_graphic_outlines.png?1575491911)
34
- ## E-Marker Chips Inside Cables
45
- All Type-C cables except the minimal combination of USB 2.0 and only 3 A must contain E-Marker chips that identify the cable and its capabilities via the USB PD protocol. This identification data includes information about product/vendor, cable connectors, USB signalling protocol (2.0, Gen speed rating , Gen 2), passive/active construction, use of VCONN power, available VBUS current, latency, RX/TX directionality, SOP controller mode, and hardware/firmware version. It also can include further vendor-defined messages (VDM) that detail support for Alt modes or vendor specific functionality outside of the USB standards.

‎pages/RaspberryPi___Zero___2w.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- [Buy a Raspberry Pi Zero 2 W – Raspberry Pi](https://www.raspberrypi.com/products/raspberry-pi-zero-2-w/)
2+
- uses [[USB]] Micro
3+
- There's a raspberry pi ISO burner for SD card

‎pages/USB___Connector___Documentation___Plan.md‎

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
tags:: [[Diataxis/Reference]], [[USB]]
2+
3+
- # USB Connector Documentation Plan
4+
- ## Overview
5+
- This plan outlines the structure for documenting various USB connector jacks in the Logseq knowledge base
6+
- Documentation will follow Diataxis Reference format for technical specifications
7+
- Uses hierarchical namespace structure consistent with existing knowledge base patterns
8+
- ## Namespace Structure
9+
- ### Main Namespace
10+
- `[[USB/Connector/Ref/ConnectorName]]`
11+
- File path: `pages/USB___Connector___Ref___ConnectorName.md`
12+
- ### Rationale
13+
- Follows existing pattern: `Topic/Subtopic/Ref/Specific Subject`
14+
- Matches structure used in other technical reference documentation
15+
- Enables easy discovery and linking
16+
- ## Documentation Structure for Each Connector
17+
- ### Required Sections (Diataxis Reference Format)
18+
- **Overview**: Brief factual description
19+
- **Physical Specifications**: Dimensions, pin count, orientation
20+
- **Technical Specifications**: USB version, data rates, power delivery
21+
- **Pin Configuration**: Pin assignments and functions
22+
- **Compatibility**: Compatible connectors and cables
23+
- **Common Use Cases**: Typical applications
24+
- **Variants**: Different versions or form factors
25+
- **Related References**: Links to related connector pages
26+
- ### Optional Sections
27+
- **Visual Reference**: Images or diagrams (stored in `assets/`)
28+
- **Standards**: USB-IF specifications and standards
29+
- **Troubleshooting Notes**: Common issues (link to How-To guides)
30+
- ## Connector Types to Document
31+
- ### USB-A Family
32+
- `[[USB/Connector/Ref/USB-A]]` - Standard USB-A connector
33+
- `[[USB/Connector/Ref/USB-A Mini]]` - Mini USB-A (if applicable)
34+
- `[[USB/Connector/Ref/USB-A Micro]]` - Micro USB-A
35+
- ### USB-B Family
36+
- `[[USB/Connector/Ref/USB-B]]` - Standard USB-B connector
37+
- `[[USB/Connector/Ref/USB-B Mini]]` - Mini USB-B
38+
- `[[USB/Connector/Ref/USB-B Micro]]` - Micro USB-B
39+
- ### USB-C Family
40+
- `[[USB/Connector/Ref/USB-C]]` - USB Type-C connector
41+
- `[[USB/Connector/Ref/USB-C Variants]]` - Different USB-C variants (if needed)
42+
- ### Proprietary Connectors
43+
- `[[USB/Connector/Ref/Lightning]]` - Apple Lightning connector (USB-based)
44+
- Other proprietary connectors as needed
45+
- ## Index/Overview Page
46+
- ### Main Index
47+
- `[[USB/Connector/Ref/Index]]` or `[[USB/Connector/Overview]]`
48+
- File: `pages/USB___Connector___Ref___Index.md`
49+
- Purpose: Quick reference table of all documented connectors
50+
- Structure:
51+
- Comparison table with key specifications
52+
- Links to individual connector pages
53+
- Visual guide to connector identification
54+
- ## Integration with Existing Content
55+
- ### Link to Existing USB Content
56+
- `[[Adafruit/Understanding USB Type C - Cable Types Pitfalls etc]]` - Already exists
57+
- Link from USB-C connector page to this resource
58+
- Consider if Adafruit content should be moved/renamed to fit structure
59+
- ### How-To Guides
60+
- Keep procedural content separate in `[[USB/How To/...]]` namespace
61+
- Examples:
62+
- `[[USB/How To/Identify Connector Type]]`
63+
- `[[USB/How To/Choose Correct Cable]]`
64+
- `[[USB/How To/Troubleshoot Connection Issues]]`
65+
- ## Asset Organization
66+
- ### Image Storage
67+
- Store connector images in `assets/usb-connectors/` directory
68+
- Naming: `usb-connector-[name]-[view].png`
69+
- Examples:
70+
- `assets/usb-connectors/usb-connector-usb-a-front.png`
71+
- `assets/usb-connectors/usb-connector-usb-c-side.png`
72+
- ### Link Format
73+
- Use Logseq asset linking: `![Description](assets/usb-connectors/filename.png)`
74+
- ## Example Page Structure
75+
- ### Template for USB-A Connector
76+
- ```markdown
77+
tags:: [[Diataxis/Reference]], [[USB]], [[USB/Connector]]
78+
79+
- # USB-A Connector Reference
80+
- ## Overview
81+
- Standard USB Type-A connector, most common USB connector type
82+
- Introduced with USB 1.0 specification (1996)
83+
- Rectangular shape, non-reversible design
84+
- ## Physical Specifications
85+
- **Dimensions**: [exact measurements]
86+
- **Pin Count**: 4 pins (USB 2.0) or 9 pins (USB 3.0+)
87+
- **Orientation**: Non-reversible (must be inserted in correct orientation)
88+
- **Gender**: Male connector (plugs into host/receptacle)
89+
- ## Technical Specifications
90+
- **USB Versions Supported**: USB 1.0, 1.1, 2.0, 3.0, 3.1, 3.2
91+
- **Data Transfer Rates**:
92+
- USB 2.0: Up to 480 Mbps
93+
- USB 3.0: Up to 5 Gbps
94+
- USB 3.1 Gen 2: Up to 10 Gbps
95+
- **Power Delivery**:
96+
- USB 2.0: Up to 2.5W (5V @ 500mA)
97+
- USB 3.0: Up to 4.5W (5V @ 900mA)
98+
- ## Pin Configuration
99+
- **USB 2.0 (4 pins)**:
100+
- Pin 1: VCC (+5V)
101+
- Pin 2: D- (Data -)
102+
- Pin 3: D+ (Data +)
103+
- Pin 4: GND (Ground)
104+
- **USB 3.0+ (9 pins)**:
105+
- Additional pins for SuperSpeed data lines
106+
- ## Compatibility
107+
- Compatible with: [[USB/Connector/Ref/USB-B]], [[USB/Connector/Ref/USB-C]] (via adapters)
108+
- Commonly paired with: [[USB/Connector/Ref/USB-B]], [[USB/Connector/Ref/USB-B Micro]]
109+
- ## Common Use Cases
110+
- Host devices (computers, hubs, chargers)
111+
- USB flash drives
112+
- Keyboard and mouse connections
113+
- Printer and scanner connections
114+
- ## Variants
115+
- USB-A 2.0 (4-pin)
116+
- USB-A 3.0 (9-pin, blue interior)
117+
- USB-A 3.1/3.2 (enhanced SuperSpeed)
118+
- ## Visual Reference
119+
- ![USB-A Connector](assets/usb-connectors/usb-connector-usb-a-front.png)
120+
- ## Related References
121+
- [[USB/Connector/Ref/Index]]
122+
- [[USB/Connector/Ref/USB-B]]
123+
- [[USB/Connector/Ref/USB-C]]
124+
- [[USB/How To/Identify Connector Type]]
125+
```
126+
- ## Implementation Priority
127+
- ### Phase 1: Core Connectors
128+
- USB-A
129+
- USB-B
130+
- USB-C
131+
- Create index page
132+
- ### Phase 2: Mini/Micro Variants
133+
- USB-B Mini
134+
- USB-B Micro
135+
- USB-A Micro (if applicable)
136+
- ### Phase 3: Specialized Connectors
137+
- Lightning
138+
- Other proprietary connectors
139+
- ### Phase 4: Enhanced Documentation
140+
- Add visual references
141+
- Create comparison tables
142+
- Link to troubleshooting guides
143+
- ## Naming Conventions
144+
- ### Page Names
145+
- Use official USB-IF naming where available
146+
- Be consistent with capitalization (USB-A, USB-B, USB-C)
147+
- Use singular form per naming conventions
148+
- ### Aliases
149+
- Add common alternative names as aliases
150+
- Example: `alias:: [[USB Type-A]], [[Standard USB]]`
151+
- ## Quality Standards
152+
- ### Reference Documentation Principles
153+
- Factual, neutral descriptions only
154+
- No opinions or marketing language
155+
- Precise technical specifications
156+
- Consistent formatting across all connector pages
157+
- ### Verification
158+
- Cross-reference with USB-IF specifications
159+
- Verify pin configurations from official sources
160+
- Ensure compatibility information is accurate
161+
- ## Related Documentation Types
162+
- ### Reference Pages (This Plan)
163+
- Technical specifications
164+
- Physical characteristics
165+
- Pin configurations
166+
- ### How-To Guides (Separate)
167+
- `[[USB/How To/Identify Connector Type]]`
168+
- `[[USB/How To/Choose Correct Cable]]`
169+
- `[[USB/How To/Troubleshoot Connection Issues]]`
170+
- ### Explanation Pages (If Needed)
171+
- `[[USB/Explanation/How USB Works]]`
172+
- `[[USB/Explanation/USB Versions and Speeds]]`
173+
- ## Maintenance
174+
- ### Updates
175+
- Update when new USB specifications are released
176+
- Keep compatibility information current
177+
- Add new connector types as they emerge
178+
- ### Cross-References
179+
- Maintain links between related connectors
180+
- Update index page when adding new connectors
181+
- Link from How-To guides to relevant connector references

‎pages/USB___Connector___Ref___Index.md‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
tags:: [[Diataxis/Reference]], [[USB]], [[USB/Connector]]
2+
3+
- # USB Connector Reference Index
4+
- ## Overview
5+
- Quick reference guide to USB connector types documented in this knowledge base
6+
- Provides comparison of key specifications and links to detailed connector pages
7+
- Organized by connector family and generation
8+
- ## Connector Comparison Table
9+
- ### Standard Connectors
10+
- | Connector | USB Versions | Max Data Rate | Power Delivery | Reversible | Common Use |
11+
|-----------|--------------|--------------|----------------|------------|------------|
12+
| [[USB/Connector/Ref/USB-A]] | 1.0-3.2 | Up to 20 Gbps (3.2 Gen 2x2) | Up to 4.5W (3.0) | No | Host devices, flash drives |
13+
| [[USB/Connector/Ref/USB-B]] | 1.0-3.2 | Up to 20 Gbps (3.2 Gen 2x2) | Up to 4.5W (3.0) | No | Peripherals, printers |
14+
| [[USB/Connector/Ref/USB-C]] | 2.0-4.0 | Up to 40 Gbps (USB4) | Up to 240W (PD 3.1) | Yes | Modern devices, laptops |
15+
- ### Mini/Micro Connectors
16+
- | Connector | USB Versions | Max Data Rate | Power Delivery | Reversible | Common Use |
17+
|-----------|--------------|--------------|----------------|------------|------------|
18+
| [[USB/Connector/Ref/USB-B Mini]] | 1.0-2.0 | Up to 480 Mbps | Up to 2.5W | No | Older cameras, MP3 players |
19+
| [[USB/Connector/Ref/USB-B Micro]] | 2.0-3.0 | Up to 5 Gbps (3.0) | Up to 4.5W (3.0) | No | Smartphones, tablets |
20+
- ### Proprietary Connectors
21+
- | Connector | USB Versions | Max Data Rate | Power Delivery | Reversible | Common Use |
22+
|-----------|--------------|--------------|----------------|------------|------------|
23+
| [[USB/Connector/Ref/Lightning]] | 2.0-3.0 | Up to 5 Gbps (3.0) | Up to 12W | Yes | Apple devices (iPhone, iPad) |
24+
- ## Connector Identification Guide
25+
- ### USB-A
26+
- Rectangular, non-reversible
27+
- 4 pins (USB 2.0) or 9 pins (USB 3.0+)
28+
- Blue interior indicates USB 3.0+
29+
- See: [[USB/Connector/Ref/USB-A]]
30+
- ### USB-B
31+
- Square with beveled corners, non-reversible
32+
- 4 pins (USB 2.0) or 9 pins (USB 3.0+)
33+
- Commonly found on printers and scanners
34+
- See: [[USB/Connector/Ref/USB-B]]
35+
- ### USB-C
36+
- Oval/rounded rectangle, fully reversible
37+
- 24 pins
38+
- Supports USB4, Thunderbolt, DisplayPort Alt Mode
39+
- See: [[USB/Connector/Ref/USB-C]]
40+
- ### USB-B Mini
41+
- Small trapezoidal shape, non-reversible
42+
- 5 pins
43+
- Largely superseded by Micro USB
44+
- See: [[USB/Connector/Ref/USB-B Mini]]
45+
- ### USB-B Micro
46+
- Small rectangular shape, non-reversible
47+
- 5 pins (USB 2.0) or 10 pins (USB 3.0)
48+
- Common on Android devices
49+
- See: [[USB/Connector/Ref/USB-B Micro]]
50+
- ### Lightning
51+
- Small, symmetrical, fully reversible
52+
- 8 pins
53+
- Apple proprietary connector
54+
- See: [[USB/Connector/Ref/Lightning]]
55+
- ## USB Version Reference
56+
- ### USB 1.0/1.1
57+
- Data Rate: 1.5 Mbps (Low-Speed) / 12 Mbps (Full-Speed)
58+
- Power: 2.5W (5V @ 500mA)
59+
- Connectors: USB-A, USB-B
60+
- ### USB 2.0
61+
- Data Rate: 480 Mbps (High-Speed)
62+
- Power: 2.5W (5V @ 500mA)
63+
- Connectors: USB-A, USB-B, USB-B Mini, USB-B Micro
64+
- ### USB 3.0 (USB 3.1 Gen 1, USB 3.2 Gen 1)
65+
- Data Rate: 5 Gbps (SuperSpeed)
66+
- Power: 4.5W (5V @ 900mA)
67+
- Connectors: USB-A, USB-B, USB-B Micro, USB-C
68+
- ### USB 3.1 Gen 2 (USB 3.2 Gen 2)
69+
- Data Rate: 10 Gbps (SuperSpeed+)
70+
- Power: Up to 100W with USB-C Power Delivery
71+
- Connectors: USB-A, USB-B, USB-C
72+
- ### USB 3.2 Gen 2x2
73+
- Data Rate: 20 Gbps
74+
- Power: Up to 100W with USB-C Power Delivery
75+
- Connectors: USB-C only
76+
- ### USB4
77+
- Data Rate: 20 Gbps (Gen 2) or 40 Gbps (Gen 3)
78+
- Power: Up to 240W with USB-C Power Delivery 3.1
79+
- Connectors: USB-C only
80+
- ## Related References
81+
- [[USB/Connector/Ref/USB-A]]
82+
- [[USB/Connector/Ref/USB-B]]
83+
- [[USB/Connector/Ref/USB-C]]
84+
- [[USB/Connector/Ref/USB-B Mini]]
85+
- [[USB/Connector/Ref/USB-B Micro]]
86+
- [[USB/Connector/Ref/Lightning]]
87+
- [[Adafruit/Understanding USB Type C - Cable Types Pitfalls etc]]
88+
- [[USB/How To/Identify Connector Type]] (when created)
89+
- [[USB/How To/Choose Correct Cable]] (when created)

‎pages/USB___Connector___Ref___USB-A.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
tags:: [[Diataxis/Reference]], [[USB]], [[USB/Connector]]
2+
3+
- alias:: [[USB Type-A]], [[Standard USB]]
4+
5+
- # USB-A Connector Reference
6+
- ## Overview
7+
- Standard USB Type-A connector, the most common USB connector type
8+
- Introduced with USB 1.0 specification (1996)
9+
- Rectangular shape with non-reversible design (must be inserted in correct orientation)
10+
- Primarily used on host devices (computers, hubs, chargers) and some peripherals
11+
- ## Physical Specifications
12+
- **Dimensions**:
13+
- Width: 12.0 mm
14+
- Height: 4.5 mm
15+
- Length: Variable (depends on plug design)
16+
- **Pin Count**:
17+
- 4 pins (USB 1.0, 1.1, 2.0)
18+
- 9 pins (USB 3.0 and later)
19+
- **Orientation**: Non-reversible (must be inserted in correct orientation)
20+
- **Gender**: Male connector (plugs into host/receptacle)
21+
- **Color Coding**:
22+
- Black or white interior: USB 2.0
23+
- Blue interior: USB 3.0 and later
24+
- ## Technical Specifications
25+
- **USB Versions Supported**: USB 1.0, 1.1, 2.0, 3.0, 3.1, 3.2
26+
- **Data Transfer Rates**:
27+
- USB 1.0/1.1: 1.5 Mbps (Low-Speed) / 12 Mbps (Full-Speed)
28+
- USB 2.0: 480 Mbps (High-Speed)
29+
- USB 3.0 (3.1 Gen 1, 3.2 Gen 1): 5 Gbps (SuperSpeed)
30+
- USB 3.1 Gen 2 (3.2 Gen 2): 10 Gbps (SuperSpeed+)
31+
- USB 3.2 Gen 2x2: 20 Gbps (requires USB-C on other end)
32+
- **Power Delivery**:
33+
- USB 1.0/1.1/2.0: Up to 2.5W (5V @ 500mA)
34+
- USB 3.0 and later: Up to 4.5W (5V @ 900mA)
35+
- ## Pin Configuration
36+
- ### USB 2.0 (4 pins)
37+
- Pin 1: VCC (+5V) - Power supply
38+
- Pin 2: D- (Data -) - Differential data pair negative
39+
- Pin 3: D+ (Data +) - Differential data pair positive
40+
- Pin 4: GND (Ground) - Ground reference
41+
- ### USB 3.0+ (9 pins)
42+
- Pins 1-4: Same as USB 2.0
43+
- Pin 5: StdA_SSRX- (SuperSpeed receive negative)
44+
- Pin 6: StdA_SSRX+ (SuperSpeed receive positive)
45+
- Pin 7: GND_DRAIN (Ground for shielding)
46+
- Pin 8: StdA_SSTX- (SuperSpeed transmit negative)
47+
- Pin 9: StdA_SSTX+ (SuperSpeed transmit positive)
48+
- ## Compatibility
49+
- **Compatible Connectors**:
50+
- [[USB/Connector/Ref/USB-B]] (standard pairing)
51+
- [[USB/Connector/Ref/USB-B Mini]] (via cable)
52+
- [[USB/Connector/Ref/USB-B Micro]] (via cable)
53+
- [[USB/Connector/Ref/USB-C]] (via adapter or cable)
54+
- **Backward Compatibility**:
55+
- USB 3.0+ connectors are backward compatible with USB 2.0 devices
56+
- USB 2.0 devices will operate at USB 2.0 speeds when connected to USB 3.0+ ports
57+
- ## Common Use Cases
58+
- Host devices (computers, laptops, tablets)
59+
- USB hubs and docking stations
60+
- USB flash drives and external storage
61+
- Keyboard and mouse connections
62+
- Printer and scanner connections
63+
- Charging adapters and power banks
64+
- Audio interfaces and MIDI controllers
65+
- ## Variants
66+
- ### USB-A 2.0
67+
- 4-pin configuration
68+
- Black or white interior
69+
- Supports up to USB 2.0 speeds (480 Mbps)
70+
- ### USB-A 3.0 (USB 3.1 Gen 1, USB 3.2 Gen 1)
71+
- 9-pin configuration
72+
- Blue interior (standard color coding)
73+
- Supports up to 5 Gbps (SuperSpeed)
74+
- ### USB-A 3.1 Gen 2 (USB 3.2 Gen 2)
75+
- 9-pin configuration
76+
- Blue or teal interior
77+
- Supports up to 10 Gbps (SuperSpeed+)
78+
- ## Visual Identification
79+
- Rectangular shape with flat bottom and slightly rounded top
80+
- Hollow interior with visible pins
81+
- USB 3.0+ versions have additional pins visible inside
82+
- Color coding: Blue interior indicates USB 3.0 or later
83+
- ## Standards
84+
- Defined in USB-IF specifications
85+
- USB 1.0/1.1: USB 1.0 specification (1996)
86+
- USB 2.0: USB 2.0 specification (2000)
87+
- USB 3.0+: USB 3.0 and subsequent specifications
88+
- ## Related References
89+
- [[USB/Connector/Ref/Index]]
90+
- [[USB/Connector/Ref/USB-B]]
91+
- [[USB/Connector/Ref/USB-C]]
92+
- [[USB/Connector/Ref/USB-B Micro]]
93+
- [[USB/How To/Identify Connector Type]] (when created)
94+
- [[USB/How To/Choose Correct Cable]] (when created)

0 commit comments

Comments
 (0)