repository·main·Indexed 41 days ago
https://github.com/wokwi/wokwi-docsDocumentation for Wokwi, featuring guides on creating custom chips using JSON and C, the Chips API for analog voltage (pin_adc_read, pin_dac_write), attribute management (attr_init, attr_read), and the Framebuffer API for implementing virtual displays.
wokwi-clock-generator is a configurable component used to provide a clock signal to other parts of your circuit in the Wokwi simulator. It outputs a single clock signal on its CLK pin.The BMP180 is a barometric pressure and temperature sensor that uses an I2C interface (address 0x77). It is compatible with BMP085 libraries. It is commonly used for weather stations, altitude measurement, and climate monitoring.
| Name | Description |
|---|---|
| VCC | Voltage supply |
| 3.3V | 3.3V supply |
| GND | Ground |
| SCL | I2C clock line |
| SDA | I2C data line |
wokwi-potentiometer is a knob-controlled linear variable resistor. It can be used to simulate analog input for microcontrollers. Note that the same information applies to the wokwi-slide-potentiometer.The Wokwi TV simulates a black and white analog PAL TV screen with a resolution of 768x576 pixels and a 4:3 aspect ratio. Unlike standard composite video, Wokwi TV separates the pixel data from the synchronization signals to simplify digital microcontroller implementation.
| Name | Description |
|---|---|
IN | Data (image) signal |
SYNC | Synchronization signal |
GND | Ground |
IN pin for pixel data.SYNC pin for synchronization pulses.Wokwi for VS Code integrates with various embedded development frameworks and toolchains, allowing you to simulate projects directly from your editor. Supported environments include:
The wokwi-lcd2004 is an LCD display component featuring 4 lines and 20 characters per line. It shares the same pinout and attributes as the wokwi-lcd1602 component.
For detailed wiring and code implementation, refer to the wokwi-lcd1602 documentation.
The wokwi-ir-remote is a 38KHz infrared remote with 20 function keys. It is designed to be used in conjunction with the IR Receiver module to simulate infrared communication in Wokwi projects.
To use it in your simulation, add the <wokwi-ir-remote /> component to your diagram.
<wokwi-ir-remote />Wokwi in the Loop (WITL) is a testing methodology that combines unit testing speed with hardware realism. It allows you to:
For basic testing, use the wokwi-cli to start simulations and check serial output. For advanced testing, you can write automation scenarios to programmatically push buttons, change sensor states, and validate outputs.
The editor uses a default 2.54 mm (0.1 inch) grid for snapping parts and wires.
G to show or hide the grid and rulers.Shift while dragging to move parts or wires freely.Alt or Ctrl while dragging to use a 1.27 mm (0.05 inch) grid.Note: The grid is automatically hidden when a simulation is running and restored when it stops.
Every Wokwi simulation project uses a diagram.json file to define the virtual hardware layout. This file specifies which components are present, their visual properties, and how they are electrically connected.
The basic structure includes:
version: Always set to 1.author: The name of the creator.editor: Set to "wokwi".parts: An array of component definitions.connections: An array of wiring definitions.serialMonitor (optional): Configuration for the Serial Monitor.{
"version": 1,
"author": "Uri Shaked",
"editor": "wokwi",
"parts": [],
"connections": []
}