diff --git a/content/docs/tools/teddyCloud/tecdoc/tonies-custom-json.md b/content/docs/tools/teddyCloud/tecdoc/tonies-custom-json.md index 2e57a8be..483f11b1 100644 --- a/content/docs/tools/teddyCloud/tecdoc/tonies-custom-json.md +++ b/content/docs/tools/teddyCloud/tecdoc/tonies-custom-json.md @@ -6,6 +6,8 @@ bookCollapseSection: true # tonies.custom.json teddyCloud uses the `tonies.custom.json` file from `config` folder to read the metadata of custom tags in the same manner it's done for the official boxine tonies in the `tonies.json` file. The structure is the same, but it's not overwritten as the `tonies.json` file through regularly updates. So you can use the `tonies.custom.json` to save metadata of your own custom tags. +You can generate the required JSON data via teddyCloud GUI (Edit Tag / Create new model) and save it in the `tonies.custom.json` file, or you can generate it manually, as described below. + Initially the `tonies.custom.json` file looks like the following: ``` @@ -22,7 +24,11 @@ Enriched with metadata for the above shown custom tag the `tonies.custom.json` f [{"no": "0", "model": "123456", "audio_id": ["369519776"], "hash": ["af9e61a9c1b12138fb060908d595742334b04515"], "title": "Custom Tonie Example Title", "series": "Custom Tonies", "episodes": "This is my custom tonie", "tracks": ["Title 1", "Title 2", "Title 3", "Title 4", "Title 5", "Title 6", "Title 7", "Title 8", "Title 9", "Title 10"], "release": "0", "language": "de-de", "category": "custom", "pic": "https://upload.wikimedia.org/wikipedia/en/6/6b/Hello_Web_Series_%28Wordmark%29_Logo.png"}] ``` -This results after restart of teddyCloud in the following changed appearance in the GUI: +**Note:** After you changed the `tonies.custom.json` file you need to reload it via teddyCloud GUI ( Settings / Reload Tonies.json ) or restart the server. + +![GUI](/img/gui-tonies-reload-config.png) + +This results after reloading of the `tonies.custom.json` file in the following changed appearance in the GUI: ![Tonie Cards](/img/tonies-custom-json_filled1.png) @@ -51,7 +57,7 @@ Each element consists of a JSON object with the following keys: | release | `"0"` | currently unused | | language | `"de-de"` | language code, will be shown in the gui if it's another language than the dominant one | | category | `"custom"` | category of the custom tag, currently unused | -| pic | `"https://.../Logo.png"` | url of the picture which shall be shown as custom tag image in the GUI | +| pic | `"https://.../Logo.png"` | url of the picture which shall be shown as custom tag image in the GUI. In case of use of the custom image folder the path should be relative, like "/custom_img/Logo.png". | ### How to get the Audio ID and the Hash value of a TAF diff --git a/content/docs/tools/teddyCloud/usage/custom-tags.md b/content/docs/tools/teddyCloud/usage/custom-tags.md new file mode 100644 index 00000000..b6abc9fd --- /dev/null +++ b/content/docs/tools/teddyCloud/usage/custom-tags.md @@ -0,0 +1,56 @@ +--- +title: "Custom Tags" +description: "Information on how to set up and use custom tags in teddyCloud." +bookCollapseSection: true +--- +# Custom Tags + +To use custom tags within teddyCloud, you need to obtain specific tags and follow these steps. + +## 1. Buy specific tags + +The Toniebox only accepts specific tags that meet the following criteria: + +- Type: SLIX-L +- Privacy-Mode +- UID length: 16 characters +- UID starts with: E0 04 03 + +Note: Only a specially patched version of the CC3200 accepts other SLIX NFC tags. + +## (OPTIONAL) 2. Read and save the tag ID + +Once you place a new tag on the Toniebox, it will automatically activate privacy mode on this tag, making it unrecognizable by other NFC readers. Privacy mode must be deactivated beforehand. + +If you want to save the tag ID for later use, please use a common NFC tag reader (e.g., via an iOS or Android app). + +## 3. Place the new NFC tag on the Toniebox + +- Place the new custom NFC tag on your Toniebox for the first time. (The Toniebox will respond with an error code, but that's fine for now since no custom play has been assigned yet.) +- Check the teddyCloud GUI: Filter for last played tags to find the unknown tag you recently placed on the Toniebox. + + ![GUI](/img/tonies-custom-json_empty.png) + +## 4. Assign content + +Now you can assign content to the new custom tag: + +- Click on the "Edit" button. +- Choose a source from your library. +- Click on "Save". +- Press and hold one of the Toniebox's ears for 3 seconds to perform a freshness check. After that, your new custom tag should work. + +## 5. Change the name and picture of the custom tag + +If you want to change the name and picture of your custom tag, follow these steps: + +- Create a new "Model" as described in [tonies.custom.json config](../tecdoc/tonies-custom-json.md) and save it to your `tonies.custom.json` file. +- Go to the teddyCloud GUI, click on "Settings" and then "Reload Tonies.json". Afterwards, the added entry will be available for selection. + +![GUI](/img/gui-tonies-reload-config.png) + +- Edit your custom tag again, insert the unique ID you assigned to your new model, and click on "Save". + +![GUI](/img/gui-tonies-edit-model.png) + +The name, description and picture should now be updated. diff --git a/static/img/gui-tonies-edit-model.png b/static/img/gui-tonies-edit-model.png new file mode 100644 index 00000000..9a9884cb Binary files /dev/null and b/static/img/gui-tonies-edit-model.png differ diff --git a/static/img/gui-tonies-reload-config.png b/static/img/gui-tonies-reload-config.png new file mode 100644 index 00000000..cb8a0ebd Binary files /dev/null and b/static/img/gui-tonies-reload-config.png differ