public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added migrated 2.x add-ons

Browse Source 
Signed-off-by: Kai Kreuzer <kai@openhab.org>
This commit is contained in:
Kai Kreuzer
2020-09-21 01:58:32 +02:00
parent bbf1a7fd29
commit 6df6783b60
11662 changed files with 1302875 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
bundles/org.openhab.binding.smartthings/doc/SmartthingsInstallation.md Normal file
View File

@@ -0,0 +1,76 @@
# Installation of Smartthings code
To use the Smartthings, openHAB binding code needs to be installed on the Smartthings Hub. Currently the Smartthings code is bundled with the binding.
## Installation of artifacts on the Smartthings HUB
The following steps need to be done on the Smartthings hub using the web based [Smartthings developers tools](https://graph.api.smartthings.com/).
### Initial steps
These steps assume you already have a Smartthings Hub and have set it up. And, you have created an account.
1. Open the developers website using the link above.
2. Logon using the same email and password as on your Smartthings phone app.
3. Click on locations
4. Verify your hub is listed.
### Copying Smartthings files
The files are located in the GitHub [repository](https://github.com/openhab/openhab2-addons/tree/master/addons/binding/org.openhab.binding.smartthings/contrib).
The following files need to be deployed
* OpenHabAppV2 - This is a SmartApp that receives requests from openHAB and returns the needed data
* OpenHabDeviceHandler - This is a lower level module that provides a connection between openHAB and the Hub using the LAN connection
### Install OpenHabAppV2
1. Locate OpenHabAppV2.groovy in the /contrib/SmartApps Directory.
2. Open OpenHabAppV2.groovy in an editor (Some program you can use to copy the contents to the clipboard)
3. Copy the contents to the clipboard
4. Using the Smartthings developers tools:
5. Logon, if you are not logged on
6. Select **My SmartApps**
7. Click on the **+ New SmartApp** near the top right
8. Click on the **From Code** tab
9. Paste the contents of the clipboard
10. Click on the **Create** button near the bottom left
11. Click on **Publish -> For Me**
12. The SmartApp is now ready
### Install OpenHabDeviceHandler
1. Locate OpenHabDeviceHandler.groovy in the /contrib/DeviceHandlers Directory.
2. Open OpenHabDeviceHandler.groovy in an editor (Some program you can use to copy the contents to the clipboard)
3. Copy the contents to the clipboard
4. Using the Smartthings developers tools:
5. Select **My Device Handlers**
6. Click on the **+ Create New Device Handler** near the top right
7. Click on the **From Code** tab
8. Paste the contents of the clipboard
9. Click on the **Create** button near the bottom left
10. Click on **Publish -> For Me**
11. The Device Handler is now ready
### Create the Device
1. Using the Smartthings developers tools:
2. Select **My Devices**
3. Click on the **+ New Device** near the top right
4. Enter the following data in the form:
* Name: OpenHabDevice
* Label: OpenHabDevice
* Device Network ID: This needs to be the MAC address of your OpenHAB server with no spaces or punctuation
* Type: OpenHabDeviceHandler (This should be the last one on the list)
* Location: (Select from the dropdown)
* Hub: (Select from the dropdown)
5. Click on the **Create** button near the bottom left
6. In the Preferences section enter the following:
* ip: (This is the IP address of your openHAB server)
* mac: (This is the same as the Device Network ID but with : between segments
* port: 8080 (This is the port of the openHAB application on your server)
* Save the preferences
## Configuration in the Smartthings App
Next the App needs to be configured using the Smartthings App on your smartphone. These instructions are for the new app.
1. Start the Smartthings App on your phone
2. Select the menu (3 horizontal bars) in the upper left corner
3. Select **SmartApps**
4. Click the **+** (Add) in the upper right
5. Scroll to the bottom and select **OpenHabAppV2**
* In the selection screen select the devices you want to interact with openHAB. **Warning** devices not enabled (lacking the check mark in the box for the specific device) will be **ignored** by openHAB.
* Near the bottom of the screen is **Notify this virtual device**, click on it and select **OpenHabDevice**.
* Finally click **Done** at the bottom of the screen.

42
bundles/org.openhab.binding.smartthings/doc/Troubleshooting.md Normal file
View File

@@ -0,0 +1,42 @@
# Smartthings Binding Troubleshooting Guidelines
Below are some recommendations on resolving issues with things not working as expected
## Device specific issues
If the binding is working for some devices but there is one device that doesn't seem to work then verify that the device is supported by checking the following in the PaperUI:
1. Open the PaperUI webpage
2. Select Configuration -> Bindings -> Smartthings
3. Verify that the thing you want to use is included in the list of Supported Things
If the device is listed then create a new topic in the [openHAB Community Add-ons -> Bindings](https://community.openhab.org/c/add-ons/bindings/) website.
## Setting openHAB logs to Debug
You will need to edit the logging configuration file and set the log level for the Smartthings binding to debug.
The following assumes you are running on Linux or Raspbian
Follow these steps on your openHAB server:
1. If logged on to the server: cd /var/lib/openhab2/etc or if using Samba open file explorer to \\\\OPENHABIANPI\openHAB-userdata\etc
2. Edit the file org.ops4j.pax.logging.cfg
* Just ** before ** the line "log4j2.logger.openhab.name = org.openhab" add the following lines:
* log4j2.logger.smartthings.name=org.openhab.binding.smartthings
* log4j2.logger.smartthings.level=DEBUG
* Save the file
3. Restart the server (i.e. sudo systemctl restart openhab2.service)
## Viewing the openHAB logs
Viewing the logs is best done on the openHAB server where you can using the linux command "tail -f" to watch the log messages as they are created
Follow these steps on your openHAB server:
1. cd /var/log/openhab2 or if using Samba open file explorer to \\OPENHABIANPI\openHAB-log
2. The log file you want to see is openhab.log
3. Using unix "tail -f openhab.log"
4. Try the device that isn't working and look for log messages related to the device you are using
## Viewing Smartthings logs
On the Smartthings hub all of the incoming messages and the responses are logged. Looking at these logs can be very informative.
To view these logs perform the following steps:
1. Using the Smartthings developers [IDE](https://graph.api.smartthings.com/):
2. Logon, if you are not logged on
3. Select **Live Logging** from the top menu bar.
4. Try the device that isn't working and look for log messages related to the device you are having troubles with