Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Addon sharing #728

Merged
merged 8 commits into from
Jan 17, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions neon/pupil-cloud/add-ons/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# What Are Add-ons?

Pupil Cloud add-ons allow you to selectively upgrade services for your eye tracking device. Add-ons can be purchased through the Pupil Labs [website](https://pupil-labs.com/products/cloud/pricing). Each add-on is bound to a device.

## Register an Add-on
Typically registering an add-on can be done by clicking on a link that we send in an email when you purchase the add-on.

To manually register an add-on:
Add-ons are registered with a single user account. Typically registering an add-on can be done by clicking on a link that we send in an email when you purchase the add-on.

To manually register an add-on:

1. Click on the top right account avatar in the navigation bar, and then “Account Settings”
2. In the Cloud Add-ons tab, click on “Register Add-on”
Expand All @@ -17,7 +19,7 @@

## Link a Device

Depending on the add-on you purchased, they can be linked with a fixed number of eye tracking device. Linking a device with an add-on unlocks the functionality of the add-on for the device.
Depending on the add-on you purchased, they can be linked with a fixed number of eye tracking devices. Linking a device with an add-on unlocks the functionality of the add-on for the device.

To link a device with a registered add-on, click `Link device` in the table. The drop-down menu for the hardware serial will contain the serials of all the devices that have uploaded recordings to one of your workspaces before. You can also obtain the serial of a new device via the Companion app and enter it here.

Expand All @@ -27,15 +29,29 @@

## Devices View

The Devices view shows devices that have uploaded to workspaces you own. Here you can check how much storage each device is using in and compare this to their quota.
The Devices view shows devices that have uploaded to workspaces you own. Here you can check how much storage each device is using and compare this to their quota.

You can also the workspaces each device has uploaded to by double clicking on a device in the table.
You can also check the workspaces each device has uploaded to by double clicking on a device in the table.

![Devices Linking Devices](./link_device.png)

![Devices Storage](./device_storage.png)

::: info
**Enabling recording anonymization on upload:**<br>

Check warning on line 41 in neon/pupil-cloud/add-ons/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (anonymization)
Anonymizing recording on upload requires an Anonymization Add-on. If you have registered an Anonymization Add-on and linked a device to it you can you create a new workspace and enable `Face Blurring`. Any recording uploaded to this workspace will be anonymized.

Check warning on line 42 in neon/pupil-cloud/add-ons/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (Anonymization)

Check warning on line 42 in neon/pupil-cloud/add-ons/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling

Unknown word (Anonymization)
:::
:::

## Sharing Add-on Benefits

### Workspace Management

You can create multiple workspaces within the user account registered with an add-on. This allows you to share the benefits of your add-on with other users without them needing to purchase their own add-ons.

### Inviting Users

You can invite other users to [join your workspaces](https://docs.pupil-labs.com/neon/pupil-cloud/workspaces/). As part of your workspaces, invited users can, for example, view, edit, enrich, and download recordings based on the role assigned to them.

### Device Access

Other users can also log into the [Companion App](https://docs.pupil-labs.com/neon/data-collection/ecosystem-overview/#neon-companion-app) on the device linked to your add-on using their own accounts. They can then upload recordings to your workspaces, thereby benefiting from the add-on features.
Loading