# Before using blockly in openHAB

# Preface

Blocklies are an easy entry to the world of writing rules. However, after some times, you end up writing more and more complex rules, so more sooner than later you will encounter some challenges. This section intends to provide some hints to get started and how to deals with those challenges. Please read them carefully before asking questions in the forum.

Preface
OpenHAB Configuration Files
Creating a blockly rule via the UI
Use Frontail for viewing log files
Return to Blockly Reference

# OpenHAB Configuration Files

Some openHAB blocks rely on particular configuration files found in the openHAB configuration folder. This folder is referred to as $OPENHAB_CONF in this page, and the location of this folder for your setup can be found via the UI: Help & About -> Technical Information -> Configuration folder.

via mounting the files shares from the server to your client-PC. In the main UI as an admin you can go to Help & About and will have the different folder locations under Technical information.
- the exact configuration of the shares can be found on your server at /etc/samba/smb.conf (opens new window).
Use the share openHAB-conf when mounting it from Windows or MacOS

Link the openHAB share in Windows

Find you openHAB-Server via the network share functionality
User the share openHAB-conf to assign it to a network drive

Link the openHAB share in macOS

Finder -> Go -> Connect to Server
- Enter the username and server name to connect to the openHAB Server
- then choose the folder you want to mount

Finding it on Linux

Access the folder directly on the openHAB server at /etc/openhab

All methods reveal the following folders

html
icons
items
services
html
persistence
rules
scripts
sitemaps
sounds
things
transform

# Creating a blockly rule via the UI

go to Settings -> Rules
press on bottom right
enter a unique id and rule name for your new blockly rule
Under "When" click on "Add Trigger" to define a trigger for the rule (you may add multiple triggers which are perceived as any of those triggers may occurs which stands for an OR combination of the triggers)
- choose a title for the rule
- choose "item" (or something else) that should trigger the rule
- select the item from your model and the click PICK on the upper right corner
- choose "received a command", "was updated" or "changed"
Under "Then" click on "Add Action"
choose
click on und you should now see this screen
you can now click the to access all openHAB Blocks.
Drag and Drop the blocks to the white area
Press Ctrl-s (Windows) or Command-s (MacOS) to save your rule
Press Ctrl-r (Windows) or Command-r (MacOS) to directly run your rule with the trigger
Press Ctrl-d (Windows) or Command-d (MacOS) to disable / enable your rule
Click on on the lower right to see the generated code (click again to come back to the blocks)

# Use Frontail for viewing log files

During development the log-block is lot very often which writes information into the log files.

To be able to conveniently view your log files it is recommended to setup frontail which can be achieved easily via openhabian-config (opens new window)
Start openhabian-config on your server and choose option 20 and then option 21
After installation you can view your logs under openhabian-config (opens new window) (adapt the server name)
see how to log (opens new window)

# Return to Blockly Reference

return to Blockly Reference

Caught a mistake or want to contribute to the documentation? Edit this page on GitHub (opens new window)