---
import '../../styles/global.css';
---
<html lang="en">
<head>
<meta charset="utf-8" />
<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
<meta name="viewport" content="width=device-width" />
<meta name="generator" content={Astro.generator} />
<title>Device Models API - PoKeys Core Library</title>
<style>
aside .sidebar-nav a {
display: block !important;
width: 100% !important;
}
aside .sidebar-nav {
display: flex !important;
flex-direction: column !important;
}
</style>
</head>
<body class="bg-gray-900 text-white">
<nav class="fixed top-0 left-0 right-0 z-50 bg-gray-900/80 backdrop-blur-md border-b border-gray-800 h-16">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 h-full">
<div class="flex justify-between items-center h-full">
<a href="/core/" class="text-2xl font-bold bg-gradient-to-r from-blue-400 to-purple-500 bg-clip-text text-transparent">
PoKeys
</a>
<div class="hidden md:flex space-x-8">
<a href="/core/" class="text-gray-300 hover:text-white transition-colors">Home</a>
<a href="/core/getting-started" class="text-gray-300 hover:text-white transition-colors">Getting Started</a>
<a href="/core/examples/" class="text-gray-300 hover:text-white transition-colors">Examples</a>
<a href="/core/api/" class="text-white font-semibold">API Reference</a>
</div>
</div>
</div>
</nav>
<div class="flex min-h-screen pt-16">
<aside class="w-80 bg-gray-800/50 border-r border-gray-700 overflow-y-auto flex-shrink-0">
<div class="p-6">
<a href="/core/api/" class="text-blue-400 hover:text-blue-300 mb-4 inline-block">← Back to API Reference</a>
<h2 class="text-xl font-bold mb-6 text-white">API Reference</h2>
<div class="mb-6">
<h3 class="text-sm font-semibold text-gray-400 uppercase tracking-wider mb-3">Core APIs</h3>
<div class="space-y-1 sidebar-nav">
<a href="/core/api/device" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
Device Management
</a>
<a href="/core/api/connection" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
Connection & Enumeration
</a>
<a href="/core/api/models" class="block px-3 py-2 text-white bg-gray-700/50 rounded-md transition-colors">
Device Models
</a>
</div>
</div>
<div class="mb-6">
<h3 class="text-sm font-semibold text-gray-400 uppercase tracking-wider mb-3">I/O Operations</h3>
<div class="space-y-1 sidebar-nav">
<a href="/core/api/digital-io" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
Digital I/O
</a>
<a href="/core/api/analog-io" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
Analog I/O
</a>
<a href="/core/api/pin-functions" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
Pin Functions
</a>
</div>
</div>
<div class="mb-6">
<h3 class="text-sm font-semibold text-gray-400 uppercase tracking-wider mb-3">Control Systems</h3>
<div class="space-y-1 sidebar-nav">
<a href="/core/api/pwm" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
PWM Control
</a>
<a href="/core/api/encoders" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
Encoders
</a>
<a href="/core/api/pulse-engine" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
Pulse Engine v2
</a>
<a href="/core/api/servo-control" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
Servo Control
</a>
</div>
</div>
<div class="mb-6">
<h3 class="text-sm font-semibold text-gray-400 uppercase tracking-wider mb-3">Communication</h3>
<div class="space-y-1 sidebar-nav">
<a href="/core/api/spi" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
SPI Protocol
</a>
<a href="/core/api/i2c" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
I2C Protocol
</a>
<a href="/core/api/uart" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
UART Serial
</a>
<a href="/core/api/can" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
CAN Bus
</a>
<a href="/core/api/onewire" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
1-Wire Protocol
</a>
</div>
</div>
<div class="mb-6">
<h3 class="text-sm font-semibold text-gray-400 uppercase tracking-wider mb-3">Matrix Operations</h3>
<div class="space-y-1 sidebar-nav">
<a href="/core/api/matrix-keyboard" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
Matrix Keyboard
</a>
<a href="/core/api/led-matrix" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
LED Matrix
</a>
</div>
</div>
<div class="mb-6">
<h3 class="text-sm font-semibold text-gray-400 uppercase tracking-wider mb-3">Display & Sensors</h3>
<div class="space-y-1 sidebar-nav">
<a href="/core/api/lcd" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
LCD Display
</a>
<a href="/core/api/sensors" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
EasySensors
</a>
<a href="/core/api/rtc" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
Real-Time Clock
</a>
</div>
</div>
<div class="mb-6">
<h3 class="text-sm font-semibold text-gray-400 uppercase tracking-wider mb-3">Error Handling</h3>
<div class="space-y-1 sidebar-nav">
<a href="/core/api/errors" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
Error Types
</a>
<a href="/core/api/result-handling" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
Result Handling
</a>
</div>
</div>
<div class="mb-6">
<h3 class="text-sm font-semibold text-gray-400 uppercase tracking-wider mb-3">Types & Utilities</h3>
<div class="space-y-1 sidebar-nav">
<a href="/core/api/types" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
Core Types
</a>
<a href="/core/api/constants" class="block px-3 py-2 text-gray-300 hover:text-white hover:bg-gray-700/50 rounded-md transition-colors">
Constants
</a>
</div>
</div>
</div>
</aside>
<main class="flex-1 p-8 min-h-screen">
<div class="max-w-4xl">
<div class="mb-12">
<div class="flex items-center gap-4 mb-6">
<span class="px-3 py-1 bg-orange-600/20 text-orange-300 text-sm rounded-full">Device Models</span>
</div>
<h1 class="text-4xl font-bold mb-4 bg-gradient-to-r from-orange-400 to-red-500 bg-clip-text text-transparent">
Device Models API
</h1>
<p class="text-xl text-gray-400">
Device model definitions, pin capability validation, and hardware constraint management
</p>
</div>
<section class="mb-12">
<h2 class="text-2xl font-bold mb-4 text-white">Overview</h2>
<div class="bg-gray-800 rounded-lg p-6">
<p class="text-gray-300 mb-4">
The Device Models API provides comprehensive device model definitions that include pin capabilities,
hardware constraints, and validation functions. Each PoKeys device model has specific pin configurations
and supported features that are enforced through the model system.
</p>
<div class="grid md:grid-cols-2 gap-6">
<div>
<h3 class="text-lg font-semibold mb-2 text-orange-400">Supported Models</h3>
<ul class="text-gray-300 space-y-1 text-sm">
<li>• <strong>PoKeys55 v3</strong> - 55-pin development board</li>
<li>• <strong>PoKeys56U</strong> - USB device (55 pins, 31 CS-capable)</li>
<li>• <strong>PoKeys56E</strong> - Ethernet device (55 pins, 31 CS-capable)</li>
<li>• <strong>PoKeys57U</strong> - Advanced USB (57 pins, 33 CS-capable)</li>
<li>• <strong>PoKeys57E</strong> - Ethernet industrial (57 pins, 33 CS-capable)</li>
<li>• <strong>PoKeys58EU</strong> - Extended features device</li>
</ul>
</div>
<div>
<h3 class="text-lg font-semibold mb-2 text-red-400">Key Features</h3>
<ul class="text-gray-300 space-y-1 text-sm">
<li>• Pin capability validation</li>
<li>• Hardware constraint enforcement</li>
<li>• SPI pin reservation system</li>
<li>• PWM channel mapping</li>
<li>• Extensible model system</li>
</ul>
</div>
</div>
</div>
</section>
<section class="mb-12">
<h2 class="text-2xl font-bold mb-6 text-white">Pin Capabilities</h2>
<div class="bg-gray-800 rounded-lg p-6 mb-6">
<h3 class="text-xl font-semibold mb-4 text-orange-400">Supported Pin Functions</h3>
<div class="grid md:grid-cols-2 gap-6">
<div>
<h4 class="font-semibold text-blue-400 mb-2">Basic I/O</h4>
<ul class="text-gray-300 text-sm space-y-1">
<li>• <code>DigitalInput</code> - Digital input reading</li>
<li>• <code>DigitalOutput</code> - Digital output control</li>
<li>• <code>AnalogInput</code> - Analog voltage measurement</li>
<li>• <code>DigitalCounter</code> - Pulse counting</li>
</ul>
</div>
<div>
<h4 class="font-semibold text-purple-400 mb-2">Advanced Functions</h4>
<ul class="text-gray-300 text-sm space-y-1">
<li>• <code>PWM</code> - Pulse width modulation (pins 17-22)</li>
<li>• <code>Encoder</code> - Quadrature encoder input</li>
<li>• <code>KeyboardMatrix</code> - Matrix keyboard scanning</li>
<li>• <code>SPI_CS</code> - SPI chip select capability</li>
</ul>
</div>
</div>
</div>
<div class="bg-gray-800 rounded-lg p-6">
<h3 class="text-xl font-semibold mb-4 text-orange-400">Hardware Constraints</h3>
<div class="space-y-4">
<div class="bg-blue-900/20 border border-blue-500/30 rounded p-4">
<h4 class="text-blue-400 font-semibold mb-2">SPI Pin Reservation</h4>
<ul class="text-gray-300 text-sm space-y-1">
<li>• <strong>Pin 23 (MOSI)</strong> - Automatically reserved when SPI is enabled</li>
<li>• <strong>Pin 25 (CLK)</strong> - Automatically reserved when SPI is enabled</li>
<li>• <strong>CS Pins</strong> - 31-33 pins capable of SPI chip select per device</li>
</ul>
</div>
<div class="bg-purple-900/20 border border-purple-500/30 rounded p-4">
<h4 class="text-purple-400 font-semibold mb-2">PWM Channels</h4>
<ul class="text-gray-300 text-sm space-y-1">
<li>• <strong>6 Hardware Channels</strong> - Pins 17-22 only</li>
<li>• <strong>25MHz Clock</strong> - High precision timing</li>
<li>• <strong>Shared Period</strong> - All channels use same period</li>
</ul>
</div>
</div>
</div>
</section>
<section class="mb-12">
<h2 class="text-2xl font-bold mb-6 text-white">Device Model Comparison</h2>
<div class="bg-gray-800 rounded-lg p-6 overflow-x-auto">
<table class="w-full text-sm">
<thead>
<tr class="border-b border-gray-600">
<th class="text-left py-2 text-orange-400">Model</th>
<th class="text-left py-2 text-blue-400">Total Pins</th>
<th class="text-left py-2 text-purple-400">CS Capable</th>
<th class="text-left py-2 text-green-400">Connection</th>
<th class="text-left py-2 text-yellow-400">Special Features</th>
</tr>
</thead>
<tbody class="text-gray-300">
<tr class="border-b border-gray-700">
<td class="py-2 font-semibold">PoKeys55 v3</td>
<td class="py-2">55</td>
<td class="py-2">31</td>
<td class="py-2">USB</td>
<td class="py-2">Development board</td>
</tr>
<tr class="border-b border-gray-700">
<td class="py-2 font-semibold">PoKeys56U</td>
<td class="py-2">55</td>
<td class="py-2">31</td>
<td class="py-2">USB</td>
<td class="py-2">Compact design</td>
</tr>
<tr class="border-b border-gray-700">
<td class="py-2 font-semibold">PoKeys56E</td>
<td class="py-2">55</td>
<td class="py-2">31</td>
<td class="py-2">Ethernet</td>
<td class="py-2">Network enabled</td>
</tr>
<tr class="border-b border-gray-700">
<td class="py-2 font-semibold">PoKeys57U</td>
<td class="py-2">57</td>
<td class="py-2">33</td>
<td class="py-2">USB</td>
<td class="py-2">Extended I/O</td>
</tr>
<tr class="border-b border-gray-700">
<td class="py-2 font-semibold">PoKeys57E</td>
<td class="py-2">57</td>
<td class="py-2">33</td>
<td class="py-2">Ethernet</td>
<td class="py-2">Industrial grade</td>
</tr>
<tr>
<td class="py-2 font-semibold">PoKeys58EU</td>
<td class="py-2">58</td>
<td class="py-2">33</td>
<td class="py-2">Ethernet/USB</td>
<td class="py-2">Extended features</td>
</tr>
</tbody>
</table>
</div>
</section>
<section class="mb-12">
<h2 class="text-2xl font-bold mb-6 text-white">Validation Functions</h2>
<div class="bg-gray-800 rounded-lg p-6">
<p class="text-gray-300 mb-4">
The model system provides automatic validation to prevent hardware conflicts and ensure proper pin usage.
</p>
<div class="bg-gray-900 rounded p-4">
<h4 class="font-semibold text-yellow-400 mb-2">Example Usage</h4>
<pre class="text-gray-300"><code>// Validate pin capability before configuration
if device.is_pin_capability_supported(22, "PWM") {`{`}
device.set_pin_function(22, PinFunction::PWM)?;
{`}`} else {`{`}
return Err(PoKeysError::UnsupportedCapability);
{`}`}
// Get all capabilities for a pin
let capabilities = device.get_pin_capabilities(22);
println!(\"Pin 22 supports: {`{`}:?{`}`}\", capabilities);
// Validate before setting function
device.validate_pin_capability(23, "SPI_MOSI")?;
// This will automatically reserve pin 23 when SPI is enabled</code></pre>
</div>
</div>
</section>
<section class="mb-12">
<h2 class="text-2xl font-bold mb-4 text-white">Best Practices</h2>
<div class="bg-gray-800 rounded-lg p-6">
<div class="space-y-4">
<div>
<h3 class="text-lg font-semibold mb-2 text-green-400">Pin Configuration</h3>
<ul class="text-gray-300 space-y-1 text-sm">
<li>• Always validate pin capabilities before configuration</li>
<li>• Use device model information to check supported features</li>
<li>• Be aware of hardware constraints (SPI pin reservation, PWM channels)</li>
</ul>
</div>
<div>
<h3 class="text-lg font-semibold mb-2 text-blue-400">SPI Considerations</h3>
<ul class="text-gray-300 space-y-1 text-sm">
<li>• Pins 23 and 25 are automatically reserved when SPI is enabled</li>
<li>• Check CS capability before using pins for SPI chip select</li>
<li>• Plan SPI peripheral connections based on available CS pins</li>
</ul>
</div>
<div>
<h3 class="text-lg font-semibold mb-2 text-purple-400">PWM Planning</h3>
<ul class="text-gray-300 space-y-1 text-sm">
<li>• Only pins 17-22 support hardware PWM</li>
<li>• All PWM channels share the same period</li>
<li>• Plan servo control around 6-channel limitation</li>
</ul>
</div>
</div>
</div>
</section>
</div>
</main>
</div>
</body>
</html>