Bus Pirate user interface

From DP

(Difference between revisions)
Jump to: navigation , search
m (Macros)
Line 15: Line 15:
Read more in the [[Bus_Pirate_101_tutorial|Bus Pirate 101 tutorial]].
Read more in the [[Bus_Pirate_101_tutorial|Bus Pirate 101 tutorial]].
-
===Configuration menus===
+
===Configuration Menus===
Menu options are single character commands that configure the Bus Pirate. Type a letter, followed by <enter>, to access the menu. Some options are unavailable in some modes and on some hardware. See the [[Bus Pirate menu options guide]] for detailed explanations.
Menu options are single character commands that configure the Bus Pirate. Type a letter, followed by <enter>, to access the menu. Some options are unavailable in some modes and on some hardware. See the [[Bus Pirate menu options guide]] for detailed explanations.
-
===Bus interaction syntax===
+
===Bus Interaction Syntax===
A simple syntax is used to interact with chips. Syntax characters have the same general function in each bus mode, such as 'R' to read a byte of data.
A simple syntax is used to interact with chips. Syntax characters have the same general function in each bus mode, such as 'R' to read a byte of data.
<p style="padding-left: 30px;">[0x31 r:5]</p>
<p style="padding-left: 30px;">[0x31 r:5]</p>
Line 30: Line 30:
I2C&gt;(1)</nl2br>
I2C&gt;(1)</nl2br>
Macros perform complex actions, like scanning for I2C addresses, interrogating a smart card, or probing a JTAG chain. Macros are numbers entered inside (). Macro (0) always displays a list of macros available in the current bus mode.
Macros perform complex actions, like scanning for I2C addresses, interrogating a smart card, or probing a JTAG chain. Macros are numbers entered inside (). Macro (0) always displays a list of macros available in the current bus mode.
 +
 +
===Terminal Control===
 +
The Bus Pirate requires VT-100 (ANSI C0) terminal emulation to function properly.
 +
 +
{| class="wikitable" border="1"
 +
! Keyboard Key||Ctrl-Key||Action
 +
|-
 +
| &nbsp;[left arrow]||&nbsp;&nbsp;&nbsp;^B||Moves the cursor left one character
 +
|-
 +
| &nbsp;[right arrow]||&nbsp;&nbsp;&nbsp;^F||Moves the cursor right one character
 +
|-
 +
| &nbsp;[up arrow]||&nbsp;&nbsp;&nbsp;^P||Copies the previous command in the command history buffer to the command line
 +
|-
 +
| &nbsp;[down arrow]||&nbsp;&nbsp;&nbsp;^N||Copies the next command in the command history buffer to the command line
 +
|-
 +
| ||&nbsp;&nbsp;&nbsp;^A||Moves the cursor to the beginning of the line
 +
|-
 +
| ||&nbsp;&nbsp;&nbsp;^E||Moves the cursor to the end of the line
 +
|-
 +
| &nbsp;[backspace]||&nbsp;&nbsp;&nbsp;^D||Erases the character to the left of the cursor and moves the cursor left one character
 +
|-
 +
| &nbsp;[delete]||&nbsp;&nbsp;&nbsp;^F||Erases the character under (or to the right of) the cursor and moves the cursor left one character
 +
|}
 +
[[Category:Projects]]
[[Category:Projects]]
[[Category:Bus Pirate]]
[[Category:Bus Pirate]]

Revision as of 17:31, 5 October 2010

Talk to the Bus Pirate from a serial terminal set to 115200bps, 8/N/1.

* Syntax error, type ? for help
HiZ>

Press enter to show the command prompt if your terminal is blank.

HiZ>m <<<set mode command
1. HiZ
...
10. LCD
(1) ><<<press enter to select default option (1)
Mode selected
HiZ>

Most configuration and option prompts have a default value shown in (). Press enter to select the default option.

Read more in the Bus Pirate 101 tutorial.

Contents

Configuration Menus

Menu options are single character commands that configure the Bus Pirate. Type a letter, followed by <enter>, to access the menu. Some options are unavailable in some modes and on some hardware. See the Bus Pirate menu options guide for detailed explanations.

Bus Interaction Syntax

A simple syntax is used to interact with chips. Syntax characters have the same general function in each bus mode, such as 'R' to read a byte of data.

[0x31 r:5]

This example syntax sends a bus start , the value 0x31, and then reads 5 bytes, followed by bus stop. Up to 4000 characters of syntax may be entered into the Bus Pirate terminal at once, press enter to execute the syntax.

Macros

I2C>(0)
0.Macro menu
1.7bit address search
2.I2C sniffer
I2C>(1)

Macros perform complex actions, like scanning for I2C addresses, interrogating a smart card, or probing a JTAG chain. Macros are numbers entered inside (). Macro (0) always displays a list of macros available in the current bus mode.

Terminal Control

The Bus Pirate requires VT-100 (ANSI C0) terminal emulation to function properly.

Keyboard KeyCtrl-KeyAction
 [left arrow]   ^BMoves the cursor left one character
 [right arrow]   ^FMoves the cursor right one character
 [up arrow]   ^PCopies the previous command in the command history buffer to the command line
 [down arrow]   ^NCopies the next command in the command history buffer to the command line
   ^AMoves the cursor to the beginning of the line
   ^EMoves the cursor to the end of the line
 [backspace]   ^DErases the character to the left of the cursor and moves the cursor left one character
 [delete]   ^FErases the character under (or to the right of) the cursor and moves the cursor left one character