Skip to content

Commit 031c989

Browse files
committed
Continued adding initial skeleton markdown content
1 parent 34aaaeb commit 031c989

File tree

8 files changed

+28
-3
lines changed

8 files changed

+28
-3
lines changed

getinvolved.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
11
# Get Involved
22

3+
Want to contribute to the project? We suggest joining the developer chat, which may be accessed via your choice of IRC or Discord (both channels are bridged so you can talk to everyone from either protocol).
34

5+
* IRC: \#scopehal on irc.libera.chat
6+
* Discord: \#scopehal on 1bitsquared https://discord.gg/URuN2BuGwG
7+
8+
This is the primary mechanism for active developers to discuss features they're working on, help each other out, and coordinate the overall direction of the project.
9+
10+
We also host developer meetings on Zoom, typically about once per month. Connection and scheduling information is shared in the chat channel.

hardware.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Overview
1+
# Supported Hardware
22

3-
This is a brief list of hardware known to work with by libscopehal, sorted by manufacturer. Similar models may work as well although correct functionality is not guaranteed. We'd love to hear results (successful or otherwise) of testing with instruments not listed here.
3+
This is a brief list of hardware known to work with by libscopehal and ngscopeclient, sorted by manufacturer. Similar models may work as well although correct functionality is not guaranteed. We'd love to hear results (successful or otherwise) of testing with instruments not listed here.
44

55
For full details on which features are or are not supported by particular drivers, known issues, etc. please see the appropriate section of the manual.
66

index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1+
# Welcome

libscopehal.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# What is libscopehal?

multiscope.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Multi-scope support
2+
3+
Ngscopeclient allows a single session to connect to arbitrarily many oscilloscopes simultaneously. These instruments can be fully independent of each other (triggering with no relationship to the others) or grouped into "trigger groups", via a cross-trigger sync cable, allowing several instruments to trigger in lock-step.
4+
5+
Any number of oscilloscopes, of any supported make or model, may be combined in the same trigger group. Sample rates need not be the same, and the horizontal positions of each instrument within a group may be adjusted independently. This allows complex analytical setups for study of behavior across varying time scales:
6+
7+
* Use a high speed oscilloscope to identify packets or signal integrity issues in a gigabit serial signal, then trigger a low-speed instrument recording tens or hundreds of ms of activity on status GPIOs, MDIO or I2C buses, etc. before and after the high speed events
8+
* Combine multiple instruments to capture data on more channels than a single instrument can support
9+
* Use two or more instruments to capture cause-and-effect pairs on different channels separated by arbitrarily long time periods, while displaying on a single timeline
10+
11+
An automated deskew wizard allows the cross-trigger path delay within a trigger group to be measured and calibrated out, so that waveforms from all oscilloscopes in the group will line up correctly on the timeline.
12+
13+
Protocol decodes, math functions, and filter blocks can work across inputs from multiple instruments. Most math functions require their inputs to be sampled at the same rate, so you may need to use a resampling block if the instruments are not configured identically. Most protocol decode blocks can work with inputs of different sample rates without issue as long as the deskew calibration has been performed.

ngscopeclient.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# What is ngscopeclient?

protocol-analysis.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Protocol Analysis

support.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Support
2+

0 commit comments

Comments
 (0)