mwarning / trigger

Android app to lock/unlock/ring doors. Supports generic HTTPS/SSH/Bluetooth/MQTT and Nuki Smartlock.
GNU General Public License v3.0
134 stars 22 forks source link

No documentation on JSON format. #62

Closed zelch closed 3 years ago

zelch commented 3 years ago

I was hoping to save myself some effort and write out the configuration in JSON, convert to a QR code, and scan it.

Unfortunately, I'm stuck with a very vague 'Invalid QR Code' error, looking at the source this means that something threw JSONException, but the log doesn't include the error message.

I was eventually able to figure it out by exporting as a QR code, scanning with my computer, and reading the JSON... But it would be nice if there was documentation or examples. :)

mwarning commented 3 years ago

I agree. Some documentation would be nice. :)

mwarning commented 3 years ago

But the JSON format is not really meant to be used except by developers.

The QR-Code is allowed to also be a single link (https://.., ssh://...). This is documented here: https://github.com/mwarning/trigger/blob/master/docs/documentation.md

mwarning commented 3 years ago

Let me close this one, since it is developer documentation that is missing and I do not really have enough time for that. - Sorry :)