SystemLogger

SystemLogger node is used to get system information of the device.

How to place it

pipeline = dai.Pipeline()
logger = pipeline.createSystemLogger()
dai::Pipeline pipeline;
auto logger = pipeline.create<dai::node::SystemLogger>();

Inputs and Outputs

┌──────────────┐
│              │
│              │    out
│ SystemLogger ├────────►
│              │
│              │
└──────────────┘

Message types

Usage

pipeline = dai.Pipeline()
logger = pipeline.createSystemLogger()
logger.setRate(1)  # 1 Hz

# Send system info to the host via XLink
xout = pipeline.createXLinkOut()
xout.setStreamName("sysinfo")
logger.out.link(xout.input)
dai::Pipeline pipeline;
auto logger = pipeline.create<dai::node::SystemLogger>();\
logger->setRate(1.0f);  // 1 Hz

// Send system info to the host via XLink
auto xout = pipeline.create<dai::node::XLinkOut>();
xout->setStreamName("sysinfo");
logger->out.link(xout->input);

Examples of functionality

Reference

class depthai.SystemLogger

SystemLogger node. Send system information periodically.

class Connection

Connection between an Input and Output

class Id

Node identificator. Unique for every node on a single Pipeline

getAssets(self: depthai.Node) → List[depthai.Asset]

Retrieves all nodes assets

getInputs(self: depthai.Node) → List[dai::Node::Input]

Retrieves all nodes inputs

getName(self: depthai.Node)str

Retrieves nodes name

getOutputs(self: depthai.Node) → List[dai::Node::Output]

Retrieves all nodes outputs

property id

Id of node

property out

Outputs SystemInformation message that carries various system information like memory and CPU usage, temperatures, …

setRate(self: depthai.SystemLogger, hz: float)None

Specify logging rate, at which messages will be sent to out output

Parameter hz:

Sending rate in hertz (messages per second)

class dai::node::SystemLogger : public dai::Node

SystemLogger node. Send system information periodically.

Public Functions

SystemLogger(const std::shared_ptr<PipelineImpl> &par, int64_t nodeId)
void setRate(float hz)

Specify logging rate, at which messages will be sent to out output

Parameters
  • hz: Sending rate in hertz (messages per second)

Public Members

Output out = {*this, "out", Output::Type::MSender, {{DatatypeEnum::SystemInformation, false}}}

Outputs SystemInformation message that carries various system information like memory and CPU usage, temperatures, …

Private Functions

std::string getName() const override

Retrieves nodes name.

std::vector<Input> getInputs() override

Retrieves all nodes inputs.

std::vector<Output> getOutputs() override

Retrieves all nodes outputs.

nlohmann::json getProperties() override
std::shared_ptr<Node> clone() override

Private Members

dai::SystemLoggerProperties properties

Got questions?

We’re always happy to help with code or other questions you might have.