Skip to content

wavedrom/vcd

Repository files navigation

Linux NAPILinux WASMMacOS NAPIMacOS WASMWindows WASM NPM version

Value Change Dump (VCD) parser using llparse

Usage

Install

npm i vcd-stream
make wasm

Require

let vcd = require('vcd-stream');

Create parser writable stream instance

let inst = vcd.parser();

General event emitter

inst.on(<eventName>, () => {});

Events:

  • $enddefinitions - when all modules/wires are defined
  • finish - end of stream
  • error - error during parsing process

Change event emitter

inst.change.on(<wireName>, (time, cmd) => {});
  • time -- change time
  • cmd -- change type

Info object

let info = inst.info;
  • info.status - ('declaration'|'simulation')
  • info.wires - hierarchy object of modules and wires

Pipe data into the instance

myStream.pipe(inst);

Test

Build / Test Napi version

npm i
npm run mocha_napi

Build / Test Wasm version

make
npm run mocha_wasm

Test all

npm test

License

MIT LICENSE