Skip to main content
Gateway events list

Gateways

Pedro Ribas avatar
Written by Pedro Ribas
Updated over 10 months ago

All events that occur on the gateway, both during the creation process and during operation, are saved in order to verify that the entire platform is functioning correctly.

If a problem occurs on the gateway, these events will help you determine the source of the problem itself and give you the keys to solve the incident.

Gateway Events:


CREATING

This is the first event that is created on a gateway and marks the start of the gateway creation process. It only appears once and is never repeated throughout the gateway’s existence.

Under normal circumstances, it will only be active for a few seconds because the process of creating the gateway infrastructure on the cloud begins immediately after.


GATEWAY_CLOUD_INFRASTRUCTURE_FAILED

It is generated if one of the components of the cloud infrastructure creation process fails due to an internal platform error.

This event appears very rarely and, in most cases, it requires eliminating the gateway and creating it again.

If this event occurs, we recommend contacting our support service by writing an email to neuron@plexo.cloud.


GATEWAY_CLOUD_INFRASTRUCTURE_PROGRESSED

This event is only generated during the gateway creation process.

It reports on the evolution of the cloud infrastructure configuration process, indicating its progress status until completion.

This event will be repeated several times during the creation process and will run approximately 2 minutes in total.


GATEWAY_CLOUD_INFRASTRUCTURE_STARTED

This event occurs during the early stages of the creation process and it indicates that the components that make up the gateway’s platform structure on the cloud have started to be created and configured.

This event will only appear once during the gateway creation process and the expected behavior is that, immediately afterwards, the GATEWAY_CLOUD_INFRASTRUCTURE_PROGRESSED event will appear, indicating that the process is being carried out correctly.


GATEWAY_CLOUD_INFRASTRUCTURE_SUCCEEDED

It confirms the complete and successful creation of all the components that make up the gateway’s platform on the cloud.

This event will appear only once during the gateway creation process and always in the initial stages.


GATEWAY_CONNECTION_STATUS_CHANGED

This event indicates that there has been a change in the gateway’s connectivity status, which can impact receiving information from the sensors. The values this event can show are the following:

Status

Description

OFFLINE

The gateway has lost connection:

· Check that there is an internet connection.

· Check that Docker is installed and that the Neuron Edge image has loaded.

· Verify that the CPU is not in hibernation or power-saving mode.

ONLINE

The gateway has a connection:

· We should be able to observe data being received from any of the sensors connected to the gateway.


GATEWAY_CREATION_FAILED

It is generated when the entire gateway creation process could not be successfully completed due to some internal failure in any of the gateway components.

This event appears very rarely and, in most cases, it requires eliminating the gateway and creating it again.

If this event occurs, we recommend contacting our support service by writing an email to neuron@plexo.cloud.


GATEWAY_CREATION_STARTED

It indicates that the software that will manage the gateway creation process is now available.

It is generated immediately after the CREATING event and it only lasts a few seconds because it precedes the creation process of the cloud infrastructure that will include the gateway components.


GATEWAY_CREATION_SUCCEEDED

This event states that the entire gateway infrastructure has been successfully completed, both on the installation’s cloud and on-premise.

It also tells us that the process of validating and registering the gateway license has been successfully completed, as well as the installation of Neuron Edge on our industrial CPU.

If our devices have been installed correctly, the search and discovery process for modules, sensors and actuators will also be completed, so we should see them in the "Summary" tab in the Neuron App Equipment section.


GATEWAY_CREATION_UNREGISTERED

It tells us that the gateway infrastructure has been successfully created, but the license registration process has not yet been completed.

The license registration is done when Neuron Edge is installed on an industrial CPU and involves entering the code you will find in step 2 of the new gateway installation process.

Once entered, Neuron Edge validates that the code is correct and, if so, continues the process of installing the gateway on the local infrastructure and discovering devices.


GATEWAY_DELETION_FAILED

It indicates that the process of deleting a gateway has failed. You can retry the deletion process, but if the problem persists, you should contact the technical support team by sending an email to neuron@plexo.cloud.


GATEWAY_DELETION_STARTED

It indicates that the gateway deletion process has begun. This process means that the gateway registration code (license) will be erased and the entire cloud infrastructure will be deleted.


GATEWAY_DELETION_SUCCEEDED

This event confirms that the gateway has been completely deleted as well as all the corresponding infrastructure on the cloud. Deleting a gateway is a permanent operation and cannot be undone.


GATEWAY_DEPLOYMENT_BUILD_STARTED

It indicates that the corresponding cloud gateway infrastructure has been created and that the cloud gateway deployment process is starting.

The deployment process involves copying the software components to be run on the industrial CPU from the cloud to the local installation.


GATEWAY_DEPLOYMENT_PROGRESSED

It indicates that the deployment process for the cloud-hosted gateway software components is being carried out successfully.


GATEWAY_DEPLOYMENT_SUCCEEDED

It marks the successful completion of the deployment process of the gateway software components on the industrial CPU.


GATEWAY_DEPLOYMENT_FAILED

This event is an error message when the deployment process of one of the gateway's software components has failed.

To fix this, you can try deploying it again. If the error continues, try deleting the gateway and starting the creation process again.


GATEWAY_DEVICE_CONNECTED

This event occurs each time we connect a new device to an IO-Link Master installed on our network.

Once the device is connected, the system will automatically recognize the device model and its features, and it will also automatically appear as connected to the device port.

We can view and interact with the new device from the list of computers and from the devices that are linked to our gateway.


GATEWAY_DEVICE_DISCONNECTED

It occurs whenever we disconnect a device from an IO-Link Master or when the device has a malfunction and we cannot access or communicate with it.

First, we should check that the cable connecting the device to the IO-Link Master is in good condition, without cuts or any damage, and that it is properly connected to the corresponding port.

If the problem continues, try connecting the same device using another cable or by connecting it to another free port on the IO-Link Master. In both cases the system will automatically recognize and display it.


GATEWAY_DEVICE_READING_FREQUENCY_CHANGED

It displays the change in the reading frequency of any sensor. This event always appears in response to a modification made by a user in a device’s reading frequency.

The event is reflected as an audit to record an intended change, and it also displays the ID of the modified sensor and the new frequency set.


GATEWAY_DEVICES_ADDED

It informs us that the devices have been correctly installed (sensors and actuators) after the automatic discovery of the devices.

This event guarantees that the devices are available to start the device monitoring process.

One of the event attributes shows us a complete list of the added devices, identified by their models and serial numbers.


GATEWAY_DEVICES_DELETED

This event is triggered when a module or a sensor is deleted and removed from the platform.

Although the device is deleted, the data stored in the assets and that are associated with it remain available to be consulted.


GATEWAY_DEVICES_DISCOVERED

This event occurs when there is a new device discovery within the local area network where our industrial CPU is located.

All discovered devices (sensors and actuators) are automatically added to the list of available devices to be added to the gateway.


GATEWAY_DISCOVERY_FAILED

It is triggered when an error occurs during the device discovery process on the local area network where our industrial CPU is located.

In this situation, it verifies that at least one module has been installed, that it is connected to a power supply and internet connection. If everything is in order, manually re-launch the device discovery process on the local area network.

If Neuron App still does not show any discovered devices, check that the network servers Neuron is looking for belong to your network and that your IO-Link Masters are accessible from that same network.

If there are no devices listed or they are incorrect, get in touch with our technical support team by sending an email to neuron@plexo.cloud.


GATEWAY_DISCOVERY_STARTED

It indicates that the automatic device discovery process has started on the local area network where the industrial CPU is installed.

Make sure that the modules are connected to the same local area network as the industrial CPU, otherwise it will not be able to find any devices in the process.


GATEWAY_DISCOVERY_SUCCEEDED

It indicates that the automatic discovery of devices has been completed on a local area network.

If the devices have been installed correctly, the process will automatically recognize them and continue adding the discovered devices to the gateway.


GATEWAY_EDGE_INFRASTRUCTURE_FAILED

It is generated if one of the Neuron Edge software components of the infrastructure creation process fails due to an internal platform error.

This event appears very rarely and, in most cases, it requires eliminating the gateway and creating it again.

If this event occurs, we recommend contacting our support service by writing an email to neuron@plexo.cloud.


GATEWAY_EDGE_INFRASTRUCTURE_PROGRESSED

This event is only generated during the gateway creation process and reports on the evolution of the Neuron Edge software creation process, indicating that it is in progress until completion.

This event will be repeated several times during the creation process and will be running for approximately 2 minutes in total.


GATEWAY_EDGE_INFRASTRUCTURE_STARTED

This event occurs during the early stages of the creation process and it indicates that the Neuron Edge software components have started to be created and configured.

This event will only appear once during the gateway creation process and the expected behavior is that, immediately afterwards, the GATEWAY_EDGE_INFRASTRUCTURE_PROGRESSED event will appear, indicating that the process is being carried out correctly.


GATEWAY_EDGE_INFRASTRUCTURE_SUCCEEDED

It confirms that all the Neuron Edge software components have been successfully and completely created.

This event will appear only once during the gateway creation process and always in the initial stages.


GATEWAY_HOSTS_DISCOVERY_PROGRESSED

This event indicates that the process of searching for servers to check for communication modules ( IO-Link Masters) inthe local area network is progressing correctly.

This process can take several minutes depending on the number of servers in our local area network.

The Neuron App event listing will show several events of this type with information on progress, ranging from 10% to showing that it has been completed to 100%.


GATEWAY_HOSTS_DISCOVERY_STARTED

This event indicates that the process of searching for servers to check for communication modules ( IO-Link Masters) in the local area network has begun.

The automatic server discovery event appears once automatically and whenever the user initiates a manual search process.


GATEWAY_HOSTS_DISCOVERY_SUCCEEDED

It indicates that the automatic discovery of communication modules (IO-Link Masters) on a local area network has been correctly completed.

From this point on, the system communicates with the modules and begins to discover connected sensors and actuators.


GATEWAY_LICENSE_REGISTRATION_FAILED

This event represents that the gateway license validation process has failed.

To solve this error, check that you have not installed the gateway software on a different computer and that you have correctly entered the new gateway registration code in the Neuron Edge installation wizard.


GATEWAY_LICENSE_REGISTRATION_STARTED

It indicates the start of the gateway license registration on the cloud infrastructure so you can start the discovery process.


GATEWAY_LICENSE_REGISTRATION_SUCCEEDED

This event informs that thegateway registration process has been successfully completed.

After this event, the system would automatically start discovering modules and devices for the new gateway.


GATEWAY_LICENSE_VALIDATION_FAILED

This event indicates that thelicense we have entered in the Neuron Edge installation software is not correct.

Please check that you have correcly copied the registration code from your gateway and try pasting it using the Ctrl+V or Cmd+V shortcuts.


GATEWAY_LICENSE_VALIDATION_SUCCEEDED

It tells you that the license you entered in the registration code is correct and the system can continue with the installation and discovery process.


GATEWAY_LICENSE_UNREGISTRATION_FAILED

The gateway license unregistration process could not be completed, so the system continues operating as usual. Try carrying out the operation again in a few minutes.


GATEWAY_LICENSE_UNREGISTRATION_STARTED

It indicates that the gateway license unregistration process has begun. This process allows you to reuse the gateway license to reinstall Neuron Edge on the same computer or on a different computer if you want to move the gateway to a different CPU than the original one.


GATEWAY_LICENSE_UNREGISTRATION_SUCCEEDED

The gateway license has been completely unregistered. From this point on, the gateway stops entering data and we can reuse the gateway registration code to reinstall the Neuron Edge software on the same or another computer.

By unregistering the gateway license, your cloud infrastructure is not deleted, so all the historical and configuration data on the gateway is maintained.


GATEWAY_MAX_INGESTION_RATE_EXCEEDED

This event is triggered when in an LoRaWAN or MQTT gateway, we set the reading frequency of the sensors in the physical installation at a rate that is higher than the frequency that we have contracted in Neuron for those sensors.

Example: Our physical installation has two temperature sensors that send their data to a gateway at a frequency of 1 reading every 10 seconds for each sensor. If we configure the sensors in Neuron with a frequency of 1 reading every minute, we are uploading data at a higher speed than the one we have contracted, so Neuron triggers this event to warn us that we are exceeding the limit that we have contracted. If we do not raise this limit (establishing a minute frequency for the sensors), the gateway will go into "THROTTLING" mode so that the data from the sensors will not be read until we set the correct reading frequency in our physical installation or select the correct frequency in Neuron.


GATEWAY_MODULE_POLLING_TIMEOUT

This event is triggered when a gateway has a faulty connection with one of the modules connected to it. You should check the physical connectivity between your gateway and the unreachable module.

If the physical connection is ok, you should check that Neuron Edge software is up and running and the Docker image is healthy. If everything is ok but the connectivity issue persists, stop the Neuron Edge Docker image and start it again. That should restart the whole edge software installation and reconnect with the module again.


GATEWAY_MODULES_ADDED

This event confirms that communication modules (IO-Link Masters) could be successfully added to the gateway, so the system can automatically start discovering devices.


GATEWAY_MODULES_DISCOVERED

This event occurs when there is a new communication module (IO-Link Master) discovery within the local area network where our industrial CPU is located.

All discovered modules are automatically added to the list of available modules to be added to the gateway.


GATEWAY_SERVER_CONNECTION_STATUS_CHANGED

This event indicates a status change from running to stopped or vice versa in the server software running at the edge, usually in a Lambda function.

If the final status is stopped, it means that the ingestion process is not working and you should check the CPU, Docker and operating system status to diagnose the problem and resume the ingestion.

If you take no action, the ingestion won't be automatically resumed, as this is a critical issue that prevents working the communication stack at the edge.


GATEWAY_SOFTWARE_INSTALLATION_SUCCEEDED

This event indicates thatNeuron Edge has been successfully installed on your industrial CPU.

From that moment on, the process of identifying servers and discovering modules and sensors begins.


GATEWAY_STATUS_CHANGED

This event indicates a status change in the communication with the cloud endpoint. The change can be from ONLINE to OFFLINE or vice versa.

If the final status is OFFLINE, it means that the communication with the cloud endpoint is lost and no data will be uploaded. You should check the physical network connection, the network protocol configuration and eventually, the cloud endpoint availability.

If you take no action, the ingestion won't be automatically resumed, and you won't see any data available until you resolve the issue and the status would change to ONLINE.


GATEWAY_TELEMETRY_DATA_UPDATED

This event occurs every time that gateway telemetry data is updated with performance data about memory usage, messages processed, etc.

This information allows you to monitor the correct performance of edge gateway's software and anticipate eventual issues like memory leaks, storage space shortage or any other related issue regarding resources.


GATEWAY_THROTTLING_TIME_ELAPSED

This event indicates that the gateway data reading throttling (due to an excessive reading frequency in MQTT gateways) has expired, and the gateway returns to ingest data normally.


If you are having problems installing your gateway or would like to know advanced details about any of the events, contact our technical support team by sending an email to neuron@plexo.cloud

Did this answer your question?