xref: /openbmc/openbmc-tools/dbus-vis/README.md (revision a3db66b3)
1This program captures & visualizes IPMI traffic on a BMC running OpenBMC. It allows the user to capture & view IPMI requests in a time line format, as well as generate commands that can talk to `ipmid` or `ipmitool` to replay those IPMI requests.
2
3## Build
4
5This program is based on Electron, and should be compatible with Windows, Linux, Mac and ChromeOS's Linux environment.
6
7The following commands are all run from this folder (where `index.html` is located.)
8
9To build and run, a user would first need to install node.js and npm (Node.js package manager), and then checkout `dbus-pcap` to this folder. To install node.js on a Ubuntu/Debian-based system:
10
11First, install `npm` and `node.js` using a method that is suitable for your setup.
12
13```
14$ node --version
15v10.20.1
16$ npm --version
176.14.4
18```
19
20Then, with `npm`, `node.js` installed and `dbus-pcap` downloaded to this folder, run the following commands:
21
221. `npm install`
23
242. `npm start`
25
26## Run
27
28### Open existing file
29
301. Select "Open an existing file"
312. Click "Open file"
323. Choose a file (The file should be a text file, and its contents should be dbus-monitor outputs)
33
34### Capture
35
361. Select "Capture on a BMC"
372. Fill the Megapede client name in the text box
383. Choose a capture mode (live or staged)
394. Click "start capture" and watch the status updates
405. Click "stop capture" when done
416. If something happens, manual clean-up might be needed, such as stopping dbus-monitor on the BMC
42
43![Image](./scrnshot.png)
44