bendudz / fpp-zettle

FPP Plugin for Zettle card devices.
5 stars 1 forks source link

Announce Zettle!

Pull Requests Welcome FPP Zettle Logo

Get yourself an iZettle device, take a donation & trigger an effect on your light show.

Getting Started

You'll need an iZettle device to use this plugin.

Either register or login with Zettle.

You will now be presented with 2 attributes you need to copy & keep safe. They won't be retrievable again so make sure you capture them:

Dataplicity Setup

This plugin relies on a secure https endpoint so Zettle can send events to you. The easiest way to set up a https endpoint is to use Dataplicity

Greg Macaree has produced an excellent getting started video for Dataplicity. You need to enable the wormhole setting and save the address, you'll need this later. Watch Greg's tutorial:

Greg Does Dataplicity

FPP

Navigate to your FPP instance.

Click 'Content Setup' > 'Plugin Manager'

Install the Announce Zettle plugin.

Once installed, navigate to 'Content Setup' > 'Zettle - Setup'.

Add your Client ID and Secret to the page & click 'Save'

This will now unlock the ability to add a Subscription that will listen for 'purchases' aka donations from our Zettle device.

Enter your Dataplicity wormhole address. ie

https://{wormhole address}/

https://wandering-sheep-0157.dataplicity.io/

Add your email address too. This is the address that is notified of any errors sending (or in Zettle's terminology, 'pushing') a transaction to your Pi.

Save the subscription.

The first time you create a subscription you will receive a test notification sent to your Raspberry Pi. This is just the Zettle API notifying you that a subscription has been set up.

Once the subscription has been created successfully, you can then select what you want to be triggered.

Navigate back to the set-up page where you can select the command to trigger once a transaction is received.

When a real transaction is received the plugin will log it to a transaction file. You can view transactions in Status / Control > Zettle - Status. This page will also allow you to clear any transactions should you wish. This is mearly for you to see what / who has used your Zettle device to donate at your show.

You will also be able to see Today/Yesterday/This Week and This Month totals. This data is pulled from zettle.

Privacy Policy

What We Collect

Absolutely nothing!

What We Don't Collect

We do not collect or store any of your personal information. The information you submit via this plugin is transmitted between your Pi & the Zettle API. Any transactions are kept on your device & are retrievable from Zettle using your API Keys (client_id & secret) should you clear them.