IniFile

Configuration of ini file

In the project directory you find the configuration mqtt-display-client.ini. Adapt this file with an editor like nano:

nano nspanelMqttBridge.ini

The file has different sections. Most of the configuration you can keep untouched. The only thing which you need to adapt to your specific environment are:

• Host name or IP address and user name and password of your mqtt broker in section [global]
• OpenHAB host name or ip address and api (if needed for your openHAB instance) in section [oh]
• The list of your NSPanels in section [panels]
• Select a language json file in section [localize]

All the other configuration settings you can keep untouched.

Section [global]

This is the main configuration section.

• broker= Set here your mqtt broker address. Adapt the ip address or use url like myLocalMQTTBroker.local
• port= You can keep the standard port 1883 if you do not have a special setup
• username= Set here your user name for the broker. Keep it empty if no username is configured
• password= Password of your mqtt broker
• topicRoot= configuration of the root path of the published topics
• reconnectDelay= Retry delay in seconds if connection is lost to broker
• publishDelay= Publish cycle in seconds for topics
• fullPublishCycle= Publish cycle even if topic content is not changed. Cycle is fullPublishCycle multiplied with publishCycle in seconds #nspanel command timeout. Time in seconds to wait until panel answers on commands witch "Done"
• cmdTimeout= NsPanel command timeout. Time in seconds to wait until panel answers on commands witch "Done"
• screensaver= brightness of the screensaver in %
• standard= standard brightness of the pages in %
• saverTimeout= screensaver timeout in seconds. 0 means no screensaver brighness change
• saverUpdate= sceensaver content update in minutes (to update the weather content). 0=Never

Section [logging]

Configuration of the python logger which is used to log events

• level= configuration of the logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
• path=" path to the log files
• file=" filename of the logger. If empty, logging in file is dispabled

Section [oh]

Section to configure the connection to openHAB

• host= host name or IP address of your openHAB instance including http:// or https:// in front.
• port= port of the openHAB REST API. This is by default 8080 for http and 8443 for https in openHAB.
• apiKey= If your REST API access is restricted you can configure an apiKey. This is not needed in case you did not change the default configuration in openHAB
• "timeout=" Timeout for REST API calls. You can keep it untouched

Section [panels]

This is the key section to configure the NSPanels at your home. Each line represent one panel. With the key before the '=' you configure the name of your panel in the nspanelMqttBridge and the string after the '=' represents the topic in of the panel which you configured in tasmota.

After the '=' you assign the root MQTT topic of the panels.

Optional you can configure the hmi version which is installed on the panel with a comma after the topic name:

• hmi1: is default an stands for the hmi from joBr99
• hmi2: stands for hmi from ticaki

In bridge adapts the compatibility to the him version automatically based on the version topic send by the panel but because this message is not send always its recommended to configure the hmi version in the ini file.

In the examlpe configuration the panal is located in the room Flur and called like this room in the bridge. It uses the hmi from joBr99 and the root topic is tasmota/NsPanel01

• Format: PanelName=RootTopic{,hmiX}
• Example: Flur=tasmota/NsPanel01,hmi1

Section [configPath]

This section defines the location of the card yaml files. This files define all the content in the panel. By default the files are dynamically reloaded from this directory when they change. You can disable this feature by setting observer to disabled. When you do this, you need to restart the systemd process after each change in the yaml files.

• cards= Path to card yaml files. Default is a directory in the openHAB config folder /etc/openhab/nspanel_cards
• observer=enabled

All .yaml files in this location will be parsed and should contain card defintions. More details how to defines cards you can find in the section Card configuration. Subdirectories in this folder are ignored.

Section [localize]

You can translate the content in the panel to different languages. This is done with the json file which is defined in the localize section. There are three language files predefined. More details in section Translation

• lang= lang/english.json
• lang= lang/english_US.json
• lang= lang/german.json

Section [skin]

You can change some default colors and icons with the json file. More details in section Skin

• skinFile= skin/default_skin.json