Skip to content

QUICKSTART.md

Latest commit

 

History

History
149 lines (113 loc) · 3.67 KB

QUICKSTART.md

File metadata and controls

149 lines (113 loc) · 3.67 KB

Wake Quick Start Guide

Get up and running with Wake in 5 minutes!

🚀 Installation

Option 1: Quick Install (Recommended)

curl -fsSL https://raw.githubusercontent.com/Try-Wind/Wake/main/install.sh | bash
source ~/.bashrc  # or ~/.zshrc

Option 2: Build from Source

git clone https://github.com/Try-Wind/Wake.git
cd Wake
cargo build --release
cargo install --path wake-cli

⚙️ Configuration

1. Configure your AI provider:

wake auth

Choose from:

  • OpenAI (GPT-4)
  • Anthropic (Claude)
  • Google (Gemini)
  • Local (Ollama)

2. Set your API key:

Enter your API key when prompted, or edit ~/.config/wake/.wake.config

🎯 Your First Commands

Generate a Driver

wake "Generate an Arduino driver for MPU6050 accelerometer"

Debug Hardware Issue

wake "My ESP32 I2C is getting NACK at address 0x68"

Calculate Timing

wake "Calculate UART baud rate prescaler for 16MHz clock targeting 9600 baud"

Analyze Circuit

wake "Calculate pull-up resistor for I2C at 3.3V, 400kHz"

💡 Example: Complete Sensor Integration

wake "Help me connect and read data from a BME280 sensor with Arduino Uno"

Wake will provide:

  1. Wiring diagram - Which pins to connect
  2. Driver code - Complete working code
  3. Example usage - How to read temperature, humidity, pressure
  4. Troubleshooting - Common issues and solutions

🔧 Hardware Tools Available

Tool Purpose Example
driver_generator Create device drivers "Generate STM32 driver for BMP280"
protocol_debugger Fix communication issues "Debug SPI returning all 0xFF"
circuit_analyzer Analyze circuits "Review my voltage divider circuit"
timing_calculator Calculate timings "PWM frequency for servo control"
pinout_mapper Map MCU pins "Available I2C pins on ESP32"
datasheet_analyzer Extract datasheet info "Register map for MPU6050"

📚 Real-World Projects

Build a Weather Station

wake "Create weather station with ESP8266, BME280, and OLED display"

Design a Drone Controller

wake "Setup flight controller with STM32F4, MPU6050, and GPS"

IoT Sensor Node

wake "Build battery-powered LoRa sensor node with deep sleep"

🎨 Tips for Best Results

  1. Be Specific: Include your MCU, voltage levels, and communication speeds
  2. Provide Context: Mention what you've tried and what errors you see
  3. Ask Follow-ups: Wake maintains context for deeper help
  4. Use Examples: "Like the Arduino Wire library but for STM32"

🆘 Common Issues

"Command not found"

export PATH="$HOME/.cargo/bin:$PATH"
source ~/.bashrc

"Permission denied" (Linux)

sudo usermod -a -G dialout $USER
# Log out and back in

"API key not set"

wake auth
# Or edit ~/.config/wake/.wake.config

🎉 Success Checklist

  • Wake installed and in PATH
  • API provider configured
  • First driver generated
  • Hardware issue debugged
  • Ready to build amazing hardware!

📖 Learn More

💬 Get Help

Wake - Hardware-first coding agent by Wind Built with ❤️ for the embedded systems community