GithubHelp home page GithubHelp logo

vcdrom's Introduction

Linux MacOS Windows NPM version PayPal donate button Coverage Status

EDITOR | TUTORIAL

Introduction

WaveDrom is a Free and Open Source online digital timing diagram (waveform) rendering engine that uses javascript, HTML5 and SVG to convert a WaveJSON input text description into SVG vector graphics.

WaveJSON is an application of the JSON format. The purpose of WaveJSON is to provide a compact exchange format for digital timing diagrams utilized by digital HW / IC engineers.

The engine is using WaveDromSkin skin mechanism to render a complete picture.

Server

svg.wavedrom.com

![Alt](https://svg.wavedrom.com/github/<USER>/<REPO>/<BRANCH>/<PATH>/<FILENAME>.json5)
![signal step4](https://svg.wavedrom.com/github/wavedrom/wavedrom/trunk/test/signal-step4.json5)

signal step4

![reg vl](https://svg.wavedrom.com/github/wavedrom/wavedrom/trunk/test/reg-vl.json5)

reg vl

<img src="https://svg.wavedrom.com/{WAVEDROM SOURCE}/>
<img src="https://svg.wavedrom.com/{signal:[{name:'clk',wave:'p......'},{name:'bus',wave:'x.34.5x',data:'head body tail'},{name:'wire',wave:'0.1..0.'}]}"/>

Web usage

WaveDrom timing diagrams can be embedded into the web pages, blogs, and wikis to be rendered by the most of modern browsers.

HTML pages

There are three steps to insert WaveDrom diagrams directly into your page:

  1. Put the following line into your HTML page <header> or <body>:

From a CDN:

<script src="https://cdnjs.cloudflare.com/ajax/libs/wavedrom/3.1.0/skins/default.js" type="text/javascript"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/wavedrom/3.1.0/wavedrom.min.js" type="text/javascript"></script>
  1. Set the onload event for the HTML body.
<body onload="WaveDrom.ProcessAll()">
  1. Insert WaveJSON source inside HTML <body> wrapped with the <script> tag:
<script type="WaveDrom">
{ signal : [
  { name: "clk",  wave: "p......" },
  { name: "bus",  wave: "x.34.5x",   data: "head body tail" },
  { name: "wire", wave: "0.1..0." },
]}
</script>

The script will find all <script type="WaveDrom"> instances and insert a timing diagram at that point.

impress.js

(http://wavedrom.com/impress.html)

Blogs & Wikis

ObservableHQ examples: (https://observablehq.com/collection/@drom/wavedrom)

Blogger integration: (http://wavedrom.blogspot.com/2011/08/wavedrom-digital-timing-diagram-in-your.html)

MediaWiki integration: (https://github.com/Martoni/mediawiki_wavedrom)

Editor

WaveDromEditor is an online real-time editor of digital timing diagrams based on the WaveDrom engine and WaveJSON format.

Standalone WaveDromEditor

Windows

  1. Download latest wavedrom-editor-v2.4.2-win-{ia32|x64}.zip release from here: releases
  2. Unzip it into a working directory.
  3. Run the editor: wavedrom-editor.exe

Linux

  1. Download the latest wavedrom-editor-v2.4.2-linux-{ia32|x64}.tar.gz release from here: releases
  2. unzip-untar the package: tar -xvzf wavedrom-editor-v2.3.2-linux-x64.tar.gz
  3. Run the editor: ./WaveDromEditor/linux64/wavedrom-editor

OS X

  1. Download the latest wavedrom-editor-v2.4.2-osx-x64.zip release from here: releases
  2. Unzip
  3. Run

Community

Please use the WaveDrom user group for discussions, questions, ideas, or whatever.

Contributing

Contributing

License

See LICENSE.

vcdrom's People

Contributors

drom avatar sifivekevin avatar stevehoover avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

vcdrom's Issues

Protocol annotations

Any thoughts about how to include higher level markers and annotations? I'm interested in processing VCD files to produce higher level annotations like I2C and SPI transactions. (Something along the lines of sigrok or gtkwave filters but using vcdrom) Ideally they'd be output by python vcd analyzer plugins. Thanks!

Feature: jump to next / prev signal change

Allow more easily navigating traces. If a particular signal has focus, filter by changes to that signal.

Zoom level should be retained.
Screen position of that next/prev signal change would preferably match the current (or first on-screen signal change's location).

Allow measurements w/snap-to

Via mouse input, dragging on a portion of the signal should allow measurements.
e.g., initially, show the time delta between the two spots.

Long-term, plan to allow other calculations (e.g., min/max, duty, etc.), as they become of interest.

load streaming JSON

Load streaming JSON messages:

https://en.wikipedia.org/wiki/JSON_streaming

Standard fields:

  • t -- time stamp (in time units compatible with VCD) optional field. If omitted, t is current time stamp
  • n -- signal name

Immediate events

...
{"t":2334534, "n":"MY_WRITE", ...}
...

Sequence (transaction)

...
{"t0":345345, "t1":34564556, "n":"SEQ_NAME", "n1":"END_BAR", "n0":"BEGIN_FOO", ....}
...

Editor mode

WaveQL editor needs to be Read-only by default.
Ctrl+E or Ctrl+Click to activate editor.
Deactivate on Defocus

PWA local file access

Help request: load local data

I run a server (interactive-ebooks.com) where I allow students to build and run in-browser Verilog coding exercises. I'm using iverilog to run the code. Given that it's easy to produce a VCD file on my server, what's the appropriate way to send back the VCD data as a string that vcdrom can load? Hopefully, something along the lines of VCDrom(div_id for the resulting viewer, string contents of a VCD file)?

Thanks for the awesome tool!

FST support?

I wanna use vcdrom with FST, is there any plan to it?

How to use!

Is it possible to use this library on a website or in Electron? What would be a good example of what components I would need to use? Also, just want to mention, I love the way this looks!

MAC key bindings don't work

Normal-->Mac

Alt0 --> Alt+º
Alt- --> Alt+–
Alt+ --> Alt+≠
Alt, --> Alt+≤
Alt. --> Alt+≥
Alt] --> Alt+‘
Alt[ --> Alt+"
Alt/ --> Alt+÷

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.