Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
codersaur authored Nov 14, 2016
1 parent 5fffade commit a65c91e
Showing 1 changed file with 36 additions and 14 deletions.
50 changes: 36 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,20 @@ This repository contains device handlers and SmartApps for use with Samsung's [S

### SmartApp Installation Procedure

#### Part One: Install the code using the SmartThings IDE

1. Within the SmartThings IDE, click '*My SmartApps*', then '*+ New SmartApp*'.
2. Select the '*From Code*' tab and paste in the contents of the relevant groovy file.
3. Click '*Create*', and then '*Publish*' *(For Me)*.
4. Using the SmartThings app on your phone, navigate to the '*Marketplace*', select '*SmartApps*', then browse to '*My Apps*' at the bottom of the list. You should see the new SmartApp available for installation.
5. Select the new SmartApp, complete the configuraiton options and press '*Done*'.


#### Part Two: Create a SmartApp instance

1. Using the SmartThings app on your phone, navigate to the '*Marketplace*'.
2. Select '*SmartApps*', then browse to '*My Apps*' at the bottom of the list.
3. Select the new SmartApp, complete the configuration options and press '*Done*'.

**Note:** Some SmartApps may support multiple instances, whereas other may only allow one instance.

## Device Handlers

* [Aeon Home Energy Meter (GEN2 - UK - 1 Clamp)](https://github.com/codersaur/SmartThings/tree/master/devices/Aeon%20Home%20Energy%20Meter%20(GEN2%20-%20UK%20-%201%20Clamp)):
Expand Down Expand Up @@ -53,23 +60,38 @@ This repository contains device handlers and SmartApps for use with Samsung's [S

### Device Handler Installation Procedure

1. Within the SmartThings IDE, click on '*My Device Handlers*' at the top, then the '*+ Create New Device Handler*' button.
2. Select the '*From Code*' tab and paste in the contents of the relevant groovy file.
3. Click '*Create*', then '*Publish*' *(For Me)*.
#### Part One: Install the code using the SmartThings IDE

1. Within the SmartThings IDE, click on '*My Device Handlers*'.
2. Click the '*+ Create New Device Handler*' button.
3. Select the '*From Code*' tab and paste in the contents of the relevant groovy file.
4. Click '*Create*'.
5. Click '*Publish*' *(For Me)*.

When you add new devices, SmartThings will automatically select the device handler with the closest-matching *fingerprint*. However, this process is not perfect and it often fails to select the desired device handler. You may also have pre-existing devices that you want to have use the new device handler. In these cases, you need to change the device type of each device instance from the IDE:
#### Part Two: Update existing device types

4. Within the SmartThings IDE, click on '*My Devices*' at the top to list all your devices.
5. Click on the appropriate device to bring up its properties, then click the '*Edit*' button at the bottom.
6. Change the '*Type*' using the drop-down box (custom devices will be near the bottom of the list).
7. Hit the '*Update*' button at the bottom.
8. **IMPORTANT:** In the SmartThings app on your phone, navigate to the device (you should the GUI has updated to reflect the new tiles configuration). Press the gear icon to edit the device's settings and review each setting to ensure it has a suitable value, then press '*Done*'. (This will trigger the *update()* command and ensure the device instance is fully initialised and ready for use with the new device handler).
When you add new devices, SmartThings will automatically select the device handler with the closest-matching *fingerprint*. However, this process is not perfect and it often fails to select the desired device handler. You may also have pre-existing devices that you want to have use the new device handler. In these cases, you need to change the device type of each device instance from the IDE.

1. Within the SmartThings IDE, click on '*My Devices*'.
2. Click on the appropriate device to bring up its properties.
3. Click the '*Edit*' button at the bottom.
4. Change the '*Type*' using the drop-down box (custom devices will be near the bottom of the list).
5. Hit the '*Update*' button at the bottom.

#### Part Three: Update existing device settings

If you have changed the type of an existing device, it is very important to update the device's settings to ensure the device instance is fully initialised and ready for use with the new device handler.

1. Within the SmartThings IDE, click on '*Live Logging*'.
2. In the SmartThings app on your phone, navigate to the device (you should find the GUI has changed to reflect the new tiles configuration).
3. Press the gear icon to edit the device's settings.
4. Review each setting to ensure it has a suitable value, then press '*Done*'.
5. Back in the SmartThings IDE, review any messages from the device in the '*Live Logging*' screen.

**Note:** Android users may encounter some errors in the SmartThings app after a device type has been changed. This can usually be resolved by completely closing the SmartThings app and restarting it.
**Note:** Android users may encounter some errors in the SmartThings app after a device type has been changed. This can usually be resolved by completely closing the SmartThings app and restarting it.

## License


Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
in compliance with the License. You may obtain a copy of the License at:

Expand Down

0 comments on commit a65c91e

Please sign in to comment.