> For the complete documentation index, see [llms.txt](https://bkbilly.gitbook.io/lnxlink/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bkbilly.gitbook.io/lnxlink/development.md).

# Development

### How to start

Create a python app `yourmodule.py` with a unique name which starts with the class Addon:

```python
class Addon():
    """Addon module"""

    def __init__(self, lnxlink):
        """Setup addon"""
        self.name = "New Module"
```

### Get Sensor information

The method `get_info` should return the value of the sensor you want to create. This can be one of these categories:

* String
* Integer
* Boolean
* JSON that contains keys with any of the above types

```python
    def get_info(self):
        """Gather information from the system"""
        return {
            "status": 5
        }
```

### Control System

You can write the command you want to run when the topic containing the `commands` string is published to the MQTT server. The argument topic is a list separated with a slash (`/`). The argument data is a string or a json.

```python
    def start_control(self, topic, data):
        """Control system"""
        print(topic)
        print(data)
```

### Expose Sensors and Controls

A new method under the `Addon` class has to be created which returns a dictionary with options specific for the sensor you want:

```python
    def exposed_controls(self):
        """Exposes to home assistant"""
        return {
            "New Module": {
                "type": "sensor",
            },
        }
```

Bellow you can read more about each available option

#### type

This is required which is responsible for sending the appropriate type of command to the discovery of home assistant. These are the available types that are supported:

* sensor
* binary\_sensor
* button
* switch
* text
* number
* select
* camera
* image
* update

#### value\_template

This is required only if the `get_info` method returns a dictionary and you want to get a value from that to display. You can change the status to the dictionary key you want:

```python
  "value_template": "{{ value_json.status }}"
```

#### attributes\_template

This will add attributes under the sensor that is created. It is recommended that these attributes should not change because it will populate the Home Assistant database.

```yaml
  "attributes_template": "{{ value_json.get('attributes') | tojson }}"
```

#### icon

Any icon supported by home assistant can be added. More information on their [site](https://www.home-assistant.io/docs/frontend/icons/).

```python
  "icon": "mdi:battery"
```

#### unit

This is used only for types `sensor` and `number` which defines the unit of measurement of the sensor.

```python
  "unit": "%"
```

#### device\_class

This is used for the sensors `binary_sensor`, `button`, `number`, `sensor`, `switch`, `update` and defines. Each sensor has different options, so you will have to read the documentation on each integration on [Home Assistant website](https://www.home-assistant.io/integrations/).

<pre class="language-python"><code class="lang-python"><strong>  "device_class": "battery"
</strong></code></pre>

#### state\_class

This is used only for the type `sensor` which is described [here](https://developers.home-assistant.io/docs/core/entity/sensor/#available-state-classes). These are the available options:

* measurement
* total
* total\_increasing

```python
  "state_class": "measurement"
```

#### entity\_category

This changes the category of the sensor to be one of these:

* diagnostic
* config

```python
  "entity_category": "diagnostic"
```

#### enabled

It tells home assistant to enable or disable the entity. By default it is `True`.

```python
  "enabled": False
```

#### entity\_picture

This is used only for the `update` sensor.

```python
  "entity_picture": "https://github.com/bkbilly/lnxlink/raw/master/logo.png?raw=true"
```

#### title

This is used only for the `update` sensor.

```python
  "title": "LNXlink"
```

#### expire\_after

This is used only for types `sensor` and `binary_sensor` which defines the number of seconds after the sensor’s state expires, if it’s not updated. After expiry, the sensor’s state becomes `unavailable`.

```python
  "expire_after": 5
```

#### install

This is used only for `update` sensor. It can be anything and it's used to enable the install option on Home Assistant.

<pre class="language-python"><code class="lang-python"><strong>  "install": "install"
</strong></code></pre>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://bkbilly.gitbook.io/lnxlink/development.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.