Skip to main content
Version: 2.3.0

Inspector

The inspector is a major tool of the Luos ecosystem. It's allowing you to link low level (embedded Luos services) and the Luos Network Display tool, through a serial binary protocol. The inspector catches all the information that passes through a Luos network and sends it to the high level to display the topology or to monitor the network online. Contrary to the gate application which become a “master” when it is in a network, The inspector application is completely transparent for you embedded application.

You can use it to catch any information on the Luos network and visualize information in the Luos SAAS.

The inspector is a simple embedded App service, so it can work on any MCU running Luos without any modification. The inspector service must be used with a driver service called pipe, allowing you to choose the communication way fitting with your project (USB, WiFi, Bluetooth, etc.). Before you may use the inspector a topology detection must be perform!

Default Inspector Process

The default behavior of the inspector is transparency. This service does not do anything until it received some special command dedicated to the inspector.

  1. At power up, the inspector is quiet and only responds to a topology detection procedure. It is possible to configure the inspector to perform a topology detection at power up (optional)
  2. The inspector waits to receive an "ask presence" message from a pipe.
  3. If the response is OK, high level can ask information from the inspector such as:
    1. routing table,
    2. statistics of a node,
    3. message passing through the network.

Inspector and pipe

In that configuration, you put two services in the node as shown below:

#include "luos.h"
#include "pipe.h"
#include "inspector.h"

int main(void)
{
Luos_Init();
Pipe_Init();
Inspector_Init();

while (1)
{
Luos_Loop();
Pipe_Loop();
Inspector_Loop();
}
}

The inspector configurations

The default process described above can be changed using different configurations that you can use on the file node_config.h.

You could need to change it if you have apps on you Luos embedded system.

ParametersDefaults valueDescription
NODETECTIONNOT DEFINEDInspector does not make detection at power up

If you have an App service on your device managing detection you should define NODETECTION avoiding useless detection from the inspector at boot.

Inspector vs. Gate

As for the gate, the inspector needs a pipe to transfer information outside the Luos network. The pipe and Inspector can be hosted into the same node or on different nodes in the network. It is recommended to have an Inspector and a pipe on the same node to not overload the Luos network with messages that can be handled locally on the node. (see the Gate page.)

The inspector can be used with The gate in a network, the gate taking control of the sensors and the inspector displaying all the information, for example.

caution

A Gate and an Inspector can not share a pipe. You must have one pipe for each service in the same network, preferably placed in the same node.