---
title: "SMA Client | Examples | N3uron KB V1.22"
slug: "sma-client-examples"
description: "SMA Client is a N3uron module that allows users to quickly and easily establish connections to SMA devices, such as inverters and Junction Boxes…"
updated: 2025-12-23T10:21:23Z
published: 2025-12-23T10:21:34Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.n3uron.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Examples

## Connecting to an SMA Inverter

In this example, the data will be obtained from an SMA inverter.

In the [Templates Catalog](/v122/docs/platform-templates-catalog), you will find two files containing template examples for both an inverter and a junction box, respectively. These templates will make it much easier for users to get started using the module and creating a model in no-time, with minimal adjustments.

- **Step 1:**Create a new module: (Config=> Modules => New Module),

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/Figure%2013-%20Create%20a%20new%20module.png)

- **Step 2:** Provide a name for the module, (in this example, SmaClient has been used) and set the module type to  SmaClient in Module Type.

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/Figure%2014-%20Configure%20the%20module(1).png)

- **Step 3:** Configure the **Logger**and **API** for this module. In this example, the default configuration has been left unchanged since, in most cases, this is a valid configuration.
- **Step 4:** Create a new channel(Config => Modules => SmaClient => Model => New Channel).

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/Figure%2015-%20Create%20a%20new%20channel.png)

- **Step 5:** Configure the channel as shown in the below image.

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/Figure%2016-%20Configure%20the%20channel(2).png)

For this example, the following fields have been configured:

- **Connection**
  - **Type:** TCP.
  - **Config:**
    - **Host:** 10.101.3.31, which is the device's IP address.
    - **TCP Port:** By default, port 4001 is used.
    - **Reconnect delay:** 60000.

- **Step 6:** Create a new device (Config => Modules => SmaClient => Model => Channel01 => New Device).

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/Figure%2017-%20Create%20a%20new%20device.png)

- **************Step 7:** Configure the device and give it a name. In this case, the device's name is Device01.

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/Figure%2018-%20Configure%20the%20device(2).png)

For this example, the following settings have been chosen:

- **Serial number:**  2.
- **Read type:** Multiple signals.

At this point, the connection is ready and we can now move on to creating new tags using the templates provided above.

- **Step 8:** Import the templates

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/Figure%2019-%20Attach%20the%20tag%20templates.png)

- **Step 9:**Create a new instance for the template SmaNet_Inverter.

![Figure 20- Create a new instance](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/Figure%2020-%20Create%20a%20new%20instance.png)

In the below image, you can see an example configuration of the custom properties for the instance created:

![Figure 21- Instance Parameters(1)](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/Figure%2021-%20Instance%20Parameters(1).png)

- **Step 10:**Adapt the imported templates for your specific application.

Users can modify, add, or remove **Custom p****roperties** for each template according to their needs.

- **Custom properties**

- **Device:** This property must follow the **<meta charset="utf-8">Channel_name/Device_name**format. In this case, Channel01/Device01 is used.
- **Module:** Enter the name of the module you created previously. In this case, SmaClient.
- **Scanrate:** Select the appropriate rate for your case, in this example it is 500 ms.

![Figure 22- Tag creation and configuration(1)](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/Figure%2022-%20Tag%20creation%20and%20configuration(1).png)

You should also adjust the source section for every tag according to your needs. The most straightforward way to do this is by exporting the template configuration to a CSV file, modifying it, and re-uploading it, which will overwrite the previous configuration.

- **Step 11:** Navigate to the **Real-Time** section and check that everything is working properly.

![Figure 23- Real-Time Tags](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/Figure%2023-%20Real-Time%20Tags.png)