N3uron

https://docs.n3uron.com/
Admin
N3uron is an accessible, scalable Industrial IoT and DataOps platform that enables collection,...
Tokens:477,275
Snippets:2,915
Trust Score:7.7
Update:7 hours ago
Show doc for...
Tokens:
Raw
### Manual Install: Start N3uron Service

Source: https://docs.n3uron.com/docs/platform-installation-and-upgrade-linux

Starts the N3uron service after installation.

```bash
sudo systemctl start n3uron
```

--------------------------------

### Manual Install: Decompress Setup File

Source: https://docs.n3uron.com/docs/platform-installation-and-upgrade-linux

Decompresses the N3uron setup archive into /opt/. Replace <arch> with the target architecture and <version> with the N3uron version.

```bash
sudo tar -xvzf n3uron-setup-<arch>-<version>.tar.gz -C /opt/
```

--------------------------------

### Initialize step CA for MQTT sample certificates

Source: https://docs.n3uron.com/docs/mqtt-client-azure-event-grid-example

Run this command to create root and intermediate certificates for the MQTT sample. Remember the password for the next step.

```shell
step ca init --deployment-type standalone --name MqttAppSamplesCA --dns localhost --address 127.0.0.1:443 --provisioner MqttAppSamplesCAProvisioner
```

--------------------------------

### Get alarm history - Request example

Source: https://docs.n3uron.com/docs/rest-api-server-calls

Example request URL for retrieving alarm history. Uses the path /000_PLANT/040_ZONE/040_MTR/COM.active with start and end dates in ISO format.

```plaintext
http://localhost:3003/alarm?cmd=history&path=/000_PLANT/040_ZONE/040_MTR/COM.active&start=2023-05-07T00:00Z&end=2023-06-07T00:00
```

--------------------------------

### Get tag filtered history - request example

Source: https://docs.n3uron.com/docs/rest-api-server-calls

Example request URL for the historyFilter command. Uses a Unix epoch timestamp for start and an ISO string for end, with a filter for POWER tags.

```plaintext
http://localhost:3003/tag?cmd=historyFilter&path=/SUNN3RGY/BLUELAKE/PVG001/PST001/INV001/&start=1619707394591&end=2021-04-29T15:10:51.174Z&options.filter=POWER
```

--------------------------------

### Example message in custom format

Source: https://docs.n3uron.com/docs/mqtt-client-parsing-examples

Shows a sample message using the custom format with three lines, each containing a tag name, value, quality, and timestamp.

```none
Product_Count|3412|192|1586938995000\r\n
Remaining|1588|192|1586938995000\r\n
Uptime|441235|192|1586938980000\r\n
```

--------------------------------

### Get tag history request example

Source: https://docs.n3uron.com/docs/rest-api-server-calls

Example URL for the /tag?cmd=history endpoint with a specific tag path and start/end times. The start is a Unix epoch timestamp and the end is an ISO string.

```plaintext
http://localhost:3003/tag?cmd=history&path=/SUNN3RGY/BLUELAKE/PVG001/PST001/INV001/ACTIVE_POWER&start=1685365215&end=2023-05-29T15:10:51.174Z
```

--------------------------------

### Get history for many tags request example

Source: https://docs.n3uron.com/docs/rest-api-server-calls

Example URL for the /tag?cmd=historyMany endpoint with two tag paths separated by a comma. The start is a Unix epoch timestamp and the end is an ISO string.

```plaintext
http://localhost:3003/tag?cmd=historyMany&paths=/SUNN3RGY/BLUELAKE/PVG001/PST001/INV001/ACTIVE_POWER,/SUNN3RGY/BLUELAKE/PVG001/PST001/INV001/VOLTAGE&start=1619707394591&end=2021-04-29T15:10:51.174Z
```

--------------------------------

### Output of kubectl get all

Source: https://docs.n3uron.com/docs/platform-installation-and-upgrade-kubernetes

Example output showing the expected running pods, services, and statefulsets after deployment.

```text
NAME           READY   STATUS    RESTARTS       AGE
pod/mongo-0    1/1     Running   1 (8m4s ago)   51m
pod/n3uron-0   1/1     Running   2 (8m ago)     20h

NAME                 TYPE        CLUSTER-IP   EXTERNAL-IP   PORT(S)     AGE
service/kubernetes   ClusterIP   10.96.0.1    <none>        443/TCP     21h
service/mongo        ClusterIP   None         <none>        27017/TCP   51m

NAME                     READY   AGE
statefulset.apps/mongo   1/1     51m
statefulset.apps/n3uron  1/1     20h
```

--------------------------------

### module_start

Source: https://docs.n3uron.com/docs/mcp-server-tools

Starts a stopped module instance and brings it to operational state. Returns void on success. The module will begin processing data and performing its configured operations. Use this to activate modules after configuration changes or a restart.

```APIDOC
## module_start

### Description
Start a stopped module instance and bring it to operational state. Returns void on success. The module will begin processing data and performing its configured operations. Use this to activate modules after configuration changes or a restart.

### Method
Write

### Parameters
#### Path Parameters
- **moduleName** (string) - Required - Name of the module instance to start. Must be an existing module instance that is currently stopped.

#### Query Parameters
- **options_actor** (string) - Optional - Identifier for audit trail purposes. Records who started the module for compliance and security tracking.

### Response
#### Success Response
Returns void on success.
```

--------------------------------

### List installed modules - GET /module?cmd=getInstalled

Source: https://docs.n3uron.com/docs/rest-api-server-calls

Retrieves the list of installed modules. The request example uses http://localhost:3003/module?cmd=getInstalled. The response is a JSON array of module names (e.g., AbbVipClient, AuditTrail, WebUI).

```plaintext
GET /module?cmd=getInstalled
```

```plaintext
http://localhost:3003/module?cmd=getInstalled
```

```json
[
  "AbbVipClient",
  "AcquisuiteXmlCollector",
  "AuditTrail",
  "AuroraClient",
  "BacnetClient",
  "CaisoAdsClient",
  "CustomClient",
  "DataDiode",
  "DataExporter",
  "DataImporter",
  "DerivedTags",
  "DnpClient",
  "DnpServer",
  ...
]
```

--------------------------------

### Stop and remove N3uron container for upgrade

Source: https://docs.n3uron.com/docs/platform-installation-and-upgrade-docker

Stops and removes the existing N3uron container (named 'n3uron' in this example) before launching a new one with the desired version. Data persists in the Docker volumes, so it is not lost during this process.

```plaintext
docker stop n3uron
docker rm n3uron
```

--------------------------------

### $.start

Source: https://docs.n3uron.com/docs/custom-client-configuration

Variable containing the timestamp of when the current step started, in UNIX epoch with milliseconds.

```APIDOC
## $.start

### Description
This variable contains the timestamp of when the current step started, in UNIX epoch with milliseconds.
```

--------------------------------

### Populate TX buffer based on tag value in Script step

Source: https://docs.n3uron.com/docs/custom-client-examples

Use in a Custom Client Write Transaction Script step to set $.tx based on the value of the 'example2' tag. The tag value is read with $.variableGet, logged, and a switch statement assigns a different buffer for values 0, 1, or 2. For any other value, $.nextStep is set to null to end the transaction.

```javascript
//Gets the tag value
let value = $.variableGet("example2");
//Prints it in the log for debugging purposes
$.logger.debug("Value is %s", value);
//Based on the value, executes one command or another
switch(value){
	case 0:
	    $.tx = Buffer.from("getStatus\x00");
	    break;
	case 1:
	    $.tx = Buffer.from("getAnalogData\x00");
	    break;
	case 2:
	    $.tx = Buffer.from("getDigitalData\x00");
	    break;
	default:
	    $.nextStep = null; //ends the transaction if command is unknown
}
```

--------------------------------

### Manual Install: Install as System Service

Source: https://docs.n3uron.com/docs/platform-installation-and-upgrade-linux

Installs N3uron as a system service using the n3uron binary.

```bash
sudo /opt/n3uron/bin/n3uron install
```

--------------------------------

### Deploy N3uron with Docker Compose

Source: https://docs.n3uron.com/docs/platform-installation-and-upgrade-docker

Starts the N3uron container defined in the compose.yaml file in detached mode. After deployment, access the WebUI at http://localhost:8003 or http://<node-ip>:8003 and log in with the password set in the environment variable.

```bash
docker compose up -d
```

--------------------------------

### license_add

Source: https://docs.n3uron.com/docs/mcp-server-tools

Installs a new license on the node. Accepts license data in JSON format and adds it to the node's license store. Returns void on success.

```APIDOC
## license_add

### Description
Installs a new license on the node. Accepts license data in JSON format and adds it to the node's license store. Returns void on success.

### Parameters
- **data** (string) - Required - Complete license data in JSON string format as provided by the licensing system. Must be valid JSON containing all required license fields and digital signatures.
- **options_actor** (string) - Optional - Identifier for audit trail purposes. Records who installed the license for compliance and security tracking.

### Response
Returns void on success.
```

--------------------------------

### Get tag views - request example

Source: https://docs.n3uron.com/docs/rest-api-server-calls

Example request URL for the getViews command.

```plaintext
http://localhost:3003/tag?cmd=getViews
```

--------------------------------

### MCP Server example prompt for historical data analysis

Source: https://docs.n3uron.com/docs/historian-introduction

Example natural-language prompt for the MCP Server module (introduced in N3uron v1.22) to query historical data, retrieve aggregates, and generate charts.

```markdown
Find the exact tag paths for /INV0[1-2]/Energy Exported,
retrieve last-week history average aggregate for every hour,
in one call, then provide insights and generate charts (trend + daily totals).
```

--------------------------------

### Request example for GET /license?cmd=read

Source: https://docs.n3uron.com/docs/rest-api-server-calls

Example request URL to retrieve license details for the file edge01-20230316.163525.n3l.

```plaintext
http://localhost:3003/license?cmd=read&name=edge01-20230316.163525.n3l
```

--------------------------------

### List available N3uron versions with winget

Source: https://docs.n3uron.com/docs/platform-installation-and-upgrade-windows

Lists all available versions of N3uron that can be installed via winget. Use this to find the version number for a specific installation.

```powershell
winget search --id N3uronConnectivitySystems.N3uron --versions --source winget
```

--------------------------------

### List tags request example with filter

Source: https://docs.n3uron.com/docs/rest-api-server-calls

Example request that lists tags under /SUNN3RGY/BLUELAKE/PVG001/ with a filter for tags starting with 'POWER'.

```plaintext
http://localhost:3003/tag?cmd=browse&path=/SUNN3RGY/BLUELAKE/PVG001/&options.filter=POWER*
```

--------------------------------

### Get subscription events - request example

Source: https://docs.n3uron.com/docs/rest-api-server-calls

Example HTTP request to retrieve subscription events with id=2 and a limit of 100.

```Markup
http://localhost:3003/tag?cmd=subscriptionEvents&id=2&limit=100
```
Tokens:
Raw