Kwikset Lock

[chrispt (Chris Pohlad-Thomas)]

Can anyone explain or point me to an explanation of the parameters for interacting through SharpTools for something like setcode? I see three parameters

[jkp]

tagging @joshua_lyon

[joshua_lyon (Josh, SharpTools.io Dashboard)]

Thanks for the tag @jkp

SharpTools exposes whatever commands are made available by the device. In most cases, these commands follow the capability definitions created by SmartThings and you can find details in the official capabilities documentation or by searching this community.

For example, you can find details on the lockCodes capability in this thread:

Capability lockCodes (update)

In preparation for the long-delayed official lock code management solution, we’re making some changes to how the “Lock Codes” capability works. The main difference is that we’re removing the actual unlock codes from the events and storage for security reasons. Also, the setCode command will add an optional name argument that will let you give meaningful names to your codes so you know which code to delete or change when you need to. We decided to store this at the device level so you can eventually manage codes directly in the device preferences. The proposed spec is below – let us know if you see anything missing or any issues that may hurt its usability. Attributes lockCodes – JSON object mapping code IDs to code names. If a code hasn’t been set it won’t appear in the mapping. Example…

And if it’s a community developed device handler, your best resource is usually in the original thread that the DTH was posted in or with the developer of that DTH.

[chrispt (Chris Pohlad-Thomas)]

Follow on question. I wanted to be able to set codes from Sharptools. I go to set the parameters and choose as an example

• Parameter 1 - 4 (next available id)
• Parameter 2 - Test Code
• Parameter 3 - 0000

It says Success, but the code is not generated.

[joshua_lyon (Josh, SharpTools.io Dashboard)]

That’s really more of a question for the specific device handler and how it works. It looks like you have the second and third parameter backwards in your example though. Reading their spec, the first parameter is the code ID, the second is the code, and the third is the code name.

Also make sure the default data types are right. The first is a number, and the second and third are strings.

If that doesn’t help, I would start by checking the attributes mentioned in the other thread… as well as watching the SmartThings IDE live logs when you send the command.

Reading through the other thread, it sounds like there are various attributes that would be helpful to check including lockCodes, codeChanged, and codeLength.

@duncan

setCode(int id, String code, String name) – Programs code code into code slot id – if the code is successfully set on the lock, it will update the lockCodes attribute value to indicate that code id is named name . The code parameter is generally a string of numerical characters, such as “0485” or “7777”. A codeChanged event will also be sent with the result of the operation, which is useful if you are editing an existing code or if the setCode fails.

[chrispt (Chris Pohlad-Thomas)]

Thanks for that information @joshua_lyon. The issue when I look in SharpTools is it asks for the parameters for it in the following order and type:

• Parameter 1 - AZ
• Paramenter 2 - AZ
• Parameter 3 - 09

I tried all different kind of iterations to make it work with no luck

[joshua_lyon (Josh, SharpTools.io Dashboard)]

SharpTools determines the variable type based on what the device handler reports.

In the case that the reported variable types appear to be wrong, you could override the parameters and set them as you desire. To do this in SharpTools, open the menu (... in the top right corner) and check the box for ‘Override Parameters’… then you’ll have access to change the parameter types by tapping on them and you can add/delete parameters.

Per the specification, it would be:

1. [09]: 4
2. [AZ]: 0000
3. [AZ]: My Cool Code

And that’s assuming that the device driver is actually following the specification!

[joshua_lyon (Josh, SharpTools.io Dashboard)]

And for reference, here’s the code from the SmartThings GitHub repository for the ‘Z-wave Lock’ device handler - specifically a link to the setCode definition for that handler:

SmartThingsCommunity/SmartThingsPublic/blob/837fe07250203e2603c676bb57e06216f1dcd9e9/devicetypes/smartthings/zwave-lock.src/zwave-lock.groovy#L1326

That’s assuming your Kwikset Lock is using this handler, but you can verify in the SmartThings IDE.

[chrispt (Chris Pohlad-Thomas)]

So, I did not add a specific DTH, so I am guessing it is using the default

[chrispt (Chris Pohlad-Thomas)]

Is it possible to use variables for the code and for the name? I’d love to create a profile that creates a code with whatever I enter along with the name and the expiration time.

[joshua_lyon (Josh, SharpTools.io Dashboard)]

@chrispt

Is it possible to use variables for the code and for the name?

If you’re referring to Tasker variables when using the SharpTools Tasker plugins, yes.

Just tap the tag icon in the action bar when you are configuring the ‘A Thing’ plugin and you can use Tasker variables as the values. (eg. %myvariable format)