Skip to content

About the documentation

The Neuron documentation is composed of a few major sections:

  • Introduction: This section provides an overview of what Neuron is, a list of features, and integration with other products on the EMQ edge.
  • Getting Started: Get started quickly with Neuron by installation or docker.
  • Dashboard Operation: Details of how to configure, operation and monitor the Neuron using web interface.
  • Module Plugins: Details of plugins information.
  • Architecture: This section describes more details about Neuron architecture, integrations and use cases.
  • Integrations: This section describes how Neuron integrated with other applications and cloud platforms.
  • Use Cases: This section describes use cases of Neuron, including industrial connectivity, Sparkplug and Unified namespace.
  • MQTT: Neuron MQTT topic and payload detailed reference.
  • API: Neuron API detailed reference.
  • Error Codes: Description of error codes that may occur when Neuron calls the http api and mqtt api.