xref: /openbmc/openbmc-tools/dbus-vis/README.md (revision 4ffeec6f)
1# dbus-vis
2
3This program captures & visualizes IPMI traffic on a BMC running OpenBMC. It
4allows the user to capture & view IPMI requests in a time line format, as well
5as generate commands that can talk to `ipmid` or `ipmitool` to replay those IPMI
6requests.
7
8## Build
9
10This program is based on Electron, and should be compatible with Windows, Linux,
11Mac and ChromeOS's Linux environment.
12
13The following commands are all run from this folder (where `index.html` is
14located.)
15
16To build and run, a user would first need to install node.js and npm (Node.js
17package manager), and then checkout `dbus-pcap` to this folder. To install
18node.js on a Ubuntu/Debian-based system:
19
20First, install `npm` and `node.js` using a method that is suitable for your
21setup.
22
23```sh
24$ node --version
25v10.20.1
26$ npm --version
276.14.4
28```
29
30Then, with `npm`, `node.js` installed and `dbus-pcap` downloaded to this folder,
31run the following commands:
32
331. `npm install`
34
352. `npm start`
36
37## Run
38
39### Open existing file
40
411. Select "Open an existing file"
422. Click "Open file"
433. Choose a file (The file should be a text file, and its contents should be
44   dbus-monitor outputs)
45
46### Capture
47
481. Select "Capture on a BMC"
492. Fill the Megapede client name in the text box
503. Choose a capture mode (live or staged)
514. Click "start capture" and watch the status updates
525. Click "stop capture" when done
536. If something happens, manual clean-up might be needed, such as stopping
54   dbus-monitor on the BMC
55
56![Image](./scrnshot.png)
57