Sigrok Wiki

https://sigrok.org/wiki/
Admin
Sigrok Wiki is a comprehensive documentation repository for sigrok, an open-source signal analysis...
Tokens:622,315
Snippets:6,623
Trust Score:9.2
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get Help for the Main API Module

Source: https://sigrok.org/wiki/Special%3AApiHelp/help

Use this example to retrieve general help information for the main API module. This is a basic starting point for exploring the API.

```api
api.php?action=help
```

--------------------------------

### Interactive Use Example

Source: https://sigrok.org/wiki/Protocol_decoder%3AIeee488

Example of launching PulseView with an IEEE-488 compatible device file.

```bash
$ pulseview -i keithley2015/keithley2015-idn.sr

```

--------------------------------

### Install Distributable Firmware

Source: https://sigrok.org/wiki/Firmware

Build and install firmware files from the sigrok-firmware repository. This process includes running autogen.sh, configure, make, and finally make install. Installation may require root privileges.

```bash
$ cd sigrok-firmware
$ ./autogen.sh
$ ./configure
$ make
$ make install (as root or using sudo, if needed)
```

--------------------------------

### Line Status Request and Response

Source: https://sigrok.org/wiki/Intronix_Logicport_LA1034

Example of a request to get the line status and its corresponding response, which includes detailed bitmasks for CLK1 and CLK2 states.

```text
 C2: Line status request:
   OUT   c2 01 00 08 00                 [REQUEST LINE STATUS and SIZE (8+1 Bytes)]
   IN    c2 03 00 00 00 ff ff ff ff 03  [1-4	: line status 0=low 1=high]
                                        [5-8	: line status 1=low 2=high]
                                        [9-10: clk status CLK1 CLK2]
   +------------------------------------------------+
   |CLK |   low    |    up    |   high   |   down   |
   |----+----------+----------+----------+----------|
   |CLK1|03h       |17h       |16h       |07h       |
   |    |0000 0011b|0001 0111b|0001 0110b|0000 0110b|
   |CLK2|03h       |2bh       |29h       |0bh       |
   |    |0000 0011b|0010 1011b|0010 1001b|0000 1001b|
   +------------------------------------------------+

```

--------------------------------

### GPIB Connection Example

Source: https://sigrok.org/wiki/Agilent_34401A

Example of specifying the GPIB connection parameter for the scpi-dmm driver.

```bash
--driver=scpi-dmm:conn=libgpib/hp34401a
```

--------------------------------

### Basic Signature Decoding with sigrok-cli

Source: https://sigrok.org/wiki/Protocol_decoder%3ASignature

This example demonstrates how to use sigrok-cli to decode a signature pattern from a logic capture file. It specifies the probes for start, stop, clock, and data signals.

```bash
$ sigrok-cli -P signature:start=D0:stop=D1:clk=D2:data=D3 -i circuit_under_test.sr
signature-1: A3A5
signature-1: 6F9A
signature-1: 6F9A
signature-1: 6F9A
...
```

--------------------------------

### Acquisition Example: 5ms Cycle

Source: https://sigrok.org/wiki/Intronix_Logicport_LA1034

This snippet provides the command sequence for a 5ms cycle acquisition. It includes output and input commands for setting up and capturing data within this short cycle.

```text
 5ms cycle:
   OUT  c3 00 02 00 00 
   OUT  c2 00 00 01 00 
   IN   c2 bf 05 
   OUT  c2 0a 00 01 00 
   IN   c2 c8 04 
   OUT  c3 00 02 00 00 
   OUT  c2 89 92 00 00 
   IN   c2 00 
   OUT  c2 89 12 36 03 

```

--------------------------------

### Acquisition Example: 500ms @ 10MHz

Source: https://sigrok.org/wiki/Intronix_Logicport_LA1034

This snippet shows the command sequence for acquiring data over 500ms at a sample rate of 10MHz. It includes both output and input commands for configuration and data retrieval.

```text
 500ms @ 10MHz:
   OUT  c3 00 02 00 00 
   OUT  c2 00 00 01 00 
   IN   c2 e7 00 
   OUT  c2 0a 00 01 00 
   IN   c2 f2 07 
   OUT  c3 00 02 00 00 
   OUT  c2 db 90 00 00 
   IN   c2 00 
   OUT  c2 db 10 0c 00 
   IN   c2 01 a9 00 f6 01 61 01 e5 00 41 01 a7 01 
   OUT  c2 db 20 0c 00 
   IN   c2 00 ed 00 25 00 90 00 96 00 26 00 0c 00 
   OUT  c2 db 30 0c 00 
   IN   c2 00 1b 00 26 00 0f 00 16 00 26 00 13 00 
   OUT  c2 db 40 0c 00 
   IN   c2 00 00 00 00 00 00 00 00 00 00 00 00 00 
   OUT  c2 db 90 0c 00 
   IN   c2 00 08 00 08 00 08 01 08 01 08 01 08 01 
   OUT  c3 00 01 00 00 
   OUT  c2 00 00 01 00 
   IN   c2 07 00 
   OUT  c1 03 00 00 00 
 

```

--------------------------------

### Acquisition Example: 500ms @ 10KHz

Source: https://sigrok.org/wiki/Intronix_Logicport_LA1034

This snippet details the command sequence for acquiring data over 500ms at a sample rate of 10KHz. It includes output and input commands for setting up the acquisition.

```text
 500ms @ 10KHZ:
   OUT  c3 00 02 00 00 
   OUT  c2 00 00 01 00 
   IN   c2 4f 02 
   OUT  c2 0a 00 01 00 
   IN   c2 f2 07 
   OUT  c3 00 02 00 00 
   OUT  c2 43 92 00 00 
   IN   c2 00 
   OUT  c2 43 12 0c 00 
   IN   c2 00 ce 01 c2 00 14 00 ac 01 c2 00 72 00 
   OUT  c2 43 22 0c 00 
   IN   c2 00 07 00 09 00 04 00 05 00 09 00 05 00 
   OUT  c2 43 32 0c 00 
   IN   c2 00 00 00 00 00 00 00 00 00 00 00 00 00 
   OUT  c2 43 42 0c 00 
   IN   c2 00 00 00 00 00 00 00 00 00 00 00 00 00 
   OUT  c2 43 92 0c 00 
   IN   c2 00 08 00 08 00 08 01 08 01 08 01 08 01 
   OUT  c3 00 01 00 00 
   OUT  c2 00 00 01 00 
   IN   c2 07 00 
   OUT  c1 03 00 00 00 
 

```

--------------------------------

### Acquisition Example: 50ms Cycle

Source: https://sigrok.org/wiki/Intronix_Logicport_LA1034

This snippet shows the command sequence for a 50ms cycle acquisition. It includes detailed output and input commands for configuring and capturing data within this cycle.

```text
 50ms cycle:
   OUT  c3 00 02 00 00 
   OUT  c2 00 00 01 00 
   IN   c2 69 01 
   OUT  c2 0a 00 01 00 
   IN   c2 a4 07 
   OUT  c3 00 02 00 00 
   OUT  c2 0f 91 00 00 
   IN   c2 00 
   OUT  c2 0f 11 5a 00 
   IN   c2 01 69 00 65 01 67 00 63 01 61 00 60 01 66 00 5e 01 60 00 5b 01 62 00 6a 01 69 00 5e 01 66 00 63 01 63 00 5d 01 64 00 5b 01 5a 00 59 01 c8 01 95 00 64 01 5f 00 5f 01 5f 00 5c 01 31 60 60 00 5e 01 5f 00 66 01 67 00 5f 01 63 00 65 01 66 00 5d 01 6a 00 60 01 60 00 5b 01 63 00 dd 00 
   OUT  c2 0f 21 5a 00 
   IN   c2 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 f1 00 da 00 cc 00 cc 00 cc 00 cc 00 cc 00 31 60 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 cc 00 99 00 
   OUT  c2 0f 31 5a 00 
   IN   c2 00 01 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 00 00 02 00 03 00 03 00 03 00 03 00 03 00 31 60 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 03 00 01 00 
   OUT  c2 0f 41 5a 00 
   IN   c2 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 31 60 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 
   OUT  c2 0f 91 5a 00 
   IN   c2 00 08 00 08 00 08 00 08 00 08 00 08 00 08 00 08 00 08 00 08 00 08 00 08 00 08 00 08 00 08 00 08 00 08 00 08 00 08 00 08 00 08 01 08 01 08 01 08 01 08 01 08 01 08 01 31 60 08 01 08 01 08 01 08 01 08 01 08 01 08 01 08 01 08 01 08 01 08 01 08 01 08 01 08 01 08 01 08 01 
   OUT  c3 00 01 00 00 
   OUT  c2 00 00 01 00 
   IN   c2 2d 00 
   OUT  c1 03 00 00 00 
 

```

--------------------------------

### Keep Alive / Packet Request

Source: https://sigrok.org/wiki/Intronix_Logicport_LA1034

Example of a potential keep-alive or packet request, noting that it is untested and the response contains an incrementing packet number.

```text
 C1|C3: Keep alive? Packet request? Something else?:
   OUT   c1 00 00 00 00                 [KEEP ALIVE and SIZE (0+1 Bytes) - untested]
   IN    c1 xx xx                       [1-2	: packet number - constantly incrementing and rolling over]
                                        (can also be:
                                             c3 00 40 00 00
                                             c3 10 00 00 00)

```

--------------------------------

### Example Configuration Settings

Source: https://sigrok.org/wiki/Common_configuration_files

This example demonstrates typical key-value pairs and array-like settings for a Sigrok application configuration file. It includes driver selection, connection details, output channel settings, and voltage/current limits.

```ini
driver = atten-pps3xxx
conn = /dev/ttyUSB1
ocp = on
output_channel = independent
output_voltage_max[CH1] = 12.00
output_current_max[CH1] = 0.020
output_enabled[CH1] = yes

```

--------------------------------

### Load Binary File with Options

Source: https://sigrok.org/wiki/Sigrok-cli

Example of loading a binary file with specified number of channels and sample rate.

```bash
$ sigrok-cli -i example.bin
             -I binary:numchannels=4:samplerate=1mhz [...]
```

--------------------------------

### Empty HID Packet Example

Source: https://sigrok.org/wiki/WCH_CH9325

This is an example of an empty HID packet sent by the CH9325 chip when no data is received on the UART. The first byte 'f0' indicates the start of a receive packet, followed by seven zero bytes.

```text
f0 00 00 00 00 00 00 00

```

--------------------------------

### New Page Creation Example

Source: https://sigrok.org/wiki/Special%3AContributions/Gicking

This snippet shows the wiki markup for creating a new page with an infobox. It includes details about the power supply model and its status.

```wikitext
{{Infobox power supply | image = 180px | name = Delta-Elektronika SM3300 Series | status = plan...
```

--------------------------------

### Get parameter information for all submodules of 'query'

Source: https://sigrok.org/wiki/Special%3AApiHelp/paraminfo

This example shows how to retrieve parameter information for all submodules of the `action=query` module by using the `+*` wildcard.

```APIDOC
## GET /api.php

### Description
Obtain information about all submodules of the 'query' API module.

### Method
GET

### Endpoint
/api.php

### Query Parameters
- **action** (string) - Required - Must be set to `paraminfo`.
- **modules** (string) - Required - Set to `query+*` to get information for all submodules of the 'query' module.

### Request Example
```
api.php?action=paraminfo&modules=query%2B*
```

### Response
#### Success Response (200)
- **paraminfo** (object) - Contains information about the requested API modules and their parameters.
  - **modules** (array) - An array of module objects, each containing details about a module's parameters.

#### Response Example
```json
{
  "batchcomplete": "",
  "paraminfo": {
    "modules": [
      {
        "name": "query+allcategories",
        "parameters": [
          {
            "name": "acprefix",
            "type": "string",
            "required": false,
            "description": "Only list categories starting with this prefix."
          }
        ]
      },
      {
        "name": "query+allimages",
        "parameters": [
          {
            "name": "aiinprop",
            "type": "string",
            "required": false,
            "description": "Which properties to include in the response."
          }
        ]
      }
    ]
  }
}
```
```

--------------------------------

### Example Infobox Template Usage

Source: https://sigrok.org/wiki/Special%3AContributions/Shire

This demonstrates the usage of an 'Infobox' template, likely for hardware documentation, with parameters for image, name, status, and source code directory.

```wiki
{{Infobox logic analyzer |
 | image = 180px
 | name = USBee AX Pro
 | status = in progress
 | source_code_dir = fx2l...
```

--------------------------------

### PulseView Acquisition with Probe Names

Source: https://sigrok.org/wiki/Protocol_decoder%3AIeee488

Example of starting PulseView with the fx2lafw driver, automatically assigning probe names for the IEEE-488 decoder. This simplifies signal assignment.

```bash
$ pulseview -d fx2lafw**:probe_names=ieee488** &

```

--------------------------------

### Clone sigrok-dumps Git Repository

Source: https://sigrok.org/wiki/Example_dumps

Use this command to clone the sigrok-dumps Git repository to get the latest example files. This is an alternative to downloading released tarballs.

```bash
$ **git clone git://sigrok.org/sigrok-dumps**
```

--------------------------------

### Benchmarking Compression Algorithms on a6000_selp1650_init.sr

Source: https://sigrok.org/wiki/Compression

This snippet shows how to decompress a file, concatenate its parts, and then benchmark compression algorithms using lzbench. It uses the same set of algorithms and parameters as the previous examples.

```bash
$ **unzip a6000_selp1650_init.sr; cat logic-1-* > all.dd** # 30641011 bytes
$ **./lzbench -i10,10 -p3 -elibdeflate,3,1/lz4/lz4fast,3,1/zstd,3,1,-20/zstdLDM,3,1,-20 all.dd**
lzbench 1.7.3 (64-bit Linux)   Assembled by P.Skibinski
Compressor name         Compress. Decompress. Compr. size  Ratio Filename
memcpy                   2031 MB/s  3033 MB/s    30641011 100.00 all.dd
libdeflate 0.7 -3         286 MB/s  2930 MB/s      165960   0.54 all.dd
libdeflate 0.7 -1         285 MB/s  2777 MB/s      186469   0.61 all.dd
lz4 1.8.0                3992 MB/s  2476 MB/s      462105   1.51 all.dd
lz4fast 1.8.0 -3         3968 MB/s  2381 MB/s      462108   1.51 all.dd
lz4fast 1.8.0 -1         4178 MB/s  2633 MB/s      462105   1.51 all.dd
zstd 1.3.4 -3            2566 MB/s  2266 MB/s      147443   0.48 all.dd
zstd 1.3.4 -1            2701 MB/s  2250 MB/s      147714   0.48 all.dd
zstd 1.3.4 --20          2609 MB/s  2196 MB/s      161938   0.53 all.dd
zstdLDM 1.3.4 -3         2519 MB/s  2131 MB/s      147443   0.48 all.dd
zstdLDM 1.3.4 -1         2630 MB/s  2179 MB/s      147714   0.48 all.dd
zstdLDM 1.3.4 --20       2507 MB/s  2209 MB/s      161938   0.53 all.dd
done... (cIters=10 dIters=10 cTime=1.0 dTime=2.0 chunkSize=1706MB cSpeed=0MB)
```

--------------------------------

### PCE PCE-322A Setup Logging Request

Source: https://sigrok.org/wiki/PCE_PCE-322A

This 10-byte packet is used to remotely set up a recording, which can start instantly or after a button press. It includes interval, date, and flags.

```text
1  | 2  | 3  | 4  | 5  | 6  | 7  | 8  | 9  | 10   
---|---|---|---|---|---|---|---|---|---
0x7e  | ?  | Interval  | Date  | Flags   
```

--------------------------------

### Retrieve Query Result in PHP Format

Source: https://sigrok.org/wiki/Special%3AApiHelp/phpfm

Use this example to get query results formatted as serialized PHP. This requires read rights and is part of the MediaWiki API.

```api
api.php?action=query&meta=siteinfo&siprop=namespaces&format=phpfm
```

--------------------------------

### New Page Creation Example

Source: https://sigrok.org/wiki/Special%3AContributions/Joee

This snippet shows the content used to create a new page, likely for a logic analyzer device. It includes an infobox template with device-specific information.

```wikitext
{{Infobox logic analyzer |
| image = 180px
| name = DSO3254A
| status = planned
| source_code_dir = dso3254a
| channels...
```

--------------------------------

### Picoscope USB Data Out Example 4

Source: https://sigrok.org/wiki/Pico_Technology_PicoScope_2406B/USB_traffic

A 64-byte data out transfer starting with '02 0e 06 05 08 00'. This sequence is observed during USB traffic analysis.

```text
Data out:   64: 02 0e 06 05 08 00 ...
```

--------------------------------

### Reset all preferences and set skin and nickname

Source: https://sigrok.org/wiki/Special%3AApiHelp/options

This example first resets all preferences and then sets the 'skin' and 'nickname' options. It demonstrates using both 'reset' and 'change' parameters, along with 'optionname' and 'optionvalue' for specific settings. A 'token' is mandatory.

```url
api.php?action=options&reset=&change=skin=monobook&optionname=nickname&optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC
```

--------------------------------

### Example Configuration Query Output (U124xx/U125xx)

Source: https://sigrok.org/wiki/Agilent_U1231A

Example output for CONF? on a U1241B indicating AC voltage in the 1000mV range with a 10000-count display.

```text
"VOLT:AC +1.000000E+00,+1.000000E-04"
```

--------------------------------

### Get parameter information for specific modules

Source: https://sigrok.org/wiki/Special%3AApiHelp/paraminfo

This example demonstrates how to retrieve parameter information for several API modules, including `action=parse`, `format=jsonfm`, `action=query&list=allpages`, and `action=query&meta=siteinfo`.

```APIDOC
## GET /api.php

### Description
Obtain information about API modules and their parameters.

### Method
GET

### Endpoint
/api.php

### Query Parameters
- **action** (string) - Required - Must be set to `paraminfo`.
- **modules** (string) - Optional - List of module names to get information for. Can specify submodules with `+`, all submodules with `+*`, or all submodules recursively with `+**`. Separate values with `|` or alternative. Maximum number of values is 50 (500 for clients allowed higher limits).
- **helpformat** (string) - Optional - Format of help strings. One of the following values: `html`, `none`, `raw`, `wikitext`. Default: `none`.

### Request Example
```
api.php?action=paraminfo&modules=parse|phpfm|query%2Ballpages|query%2Bsiteinfo
```

### Response
#### Success Response (200)
- **paraminfo** (object) - Contains information about the requested API modules and their parameters.
  - **modules** (array) - An array of module objects, each containing details about a module's parameters.
    - **name** (string) - The name of the module.
    - **parameters** (array) - An array of parameter objects for the module.
      - **name** (string) - The name of the parameter.
      - **type** (string) - The data type of the parameter.
      - **required** (boolean) - Whether the parameter is required.
      - **description** (string) - A description of the parameter.

#### Response Example
```json
{
  "batchcomplete": "",
  "paraminfo": {
    "modules": [
      {
        "name": "parse",
        "parameters": [
          {
            "name": "action",
            "type": "string",
            "required": true,
            "description": "What kind of thing to do."
          },
          {
            "name": "format",
            "type": "string",
            "required": false,
            "description": "How to format the output."
          }
        ]
      }
    ]
  }
}
```
```

--------------------------------

### Search Wiki Pages with Opensearch

Source: https://sigrok.org/wiki/Special%3AApiHelp/opensearch

Use this example to find pages whose titles begin with 'Te'. This is a basic GET request to the MediaWiki API's opensearch module.

```api
api.php?action=opensearch&search=Te
```
Tokens:
Raw