Skip to content

Commit

Permalink
Added Wiki for tonies.custom.json and some improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
henryk86 committed Apr 18, 2024
1 parent 14076d2 commit cde8785
Show file tree
Hide file tree
Showing 8 changed files with 76 additions and 2 deletions.
6 changes: 4 additions & 2 deletions content/docs/how-to-get-started/_index.md
Expand Up @@ -10,9 +10,11 @@ Let's start from zero. You have just bought a brand new Toniebox or you just fou
There are two paths you might choose from to get more out of your Toniebox.

## The easy way (techless)
You may already know creative tonies. This is the Tonies way to get your own content onto the box. We offer your an alternative way to replace all content on your Toniebox without the 90 minute or creative tonie only limit. You'll need to remove the microSD from your Box and put it into your computer. With our software [teddyBench](/docs/tools/teddybench/) you can edit the content on it. If you like you may also buy cheap SLIX-L Tags, assign your very own content to it with [teddyBench](/docs/tools/teddybench/) and design your own figurines or even create them together with your children.
You may already know creative tonies. This is the Tonies way to get your own content onto the box. We offer you an alternative way to replace all content on your Toniebox without the 90 minute or creative tonie only limit. You'll need to remove the microSD from your Box and put it into your computer. With our software [teddyBench](/docs/tools/teddybench/) you can edit the content on it. If you like you may also buy cheap SLIX-L Tags, assign your very own content to it with [teddyBench](/docs/tools/teddybench/) and design your own figurines or even create them together with your children.

If you need some more detailed steps you may check out the [Ultimate Noob Guide](https://forum.revvox.de/t/ultimate-noob-guide/98/2) in our forum.

## The complex way (tech-savy)
If Docker, DNS, MQTT and Flash are no new words for you, you may go a step further. With the open-source server [teddyCloud](/docs/tools/teddycloud/) you can run your own toniebox cloud. This allows you to serve your own content to the box over the air and you can also download the original content from the original cloud. For that you'll need to download and replace the certificates on the toniebox' flash memory.
If Docker, DNS, MQTT and Flash are no new words for you, you may go a step further. With the open-source server [teddyCloud](/docs/tools/teddycloud/) you can run your own toniebox cloud. This allows you to serve your own content to the box over the air and you can also download the original content from the original cloud. For that you'll need to download and replace the certificates on the toniebox' flash memory.

If you want to start straight ahead and own a v4 Toniebox (so based on [ESP32](https://tonies-wiki.revvox.de/docs/box-variants/esp32/)) you may shortcut to [Teddycloud ESP32 newbie documentation](https://forum.revvox.de/t/teddycloud-esp32-newbie-documentation/112) in our forum. For the other box versions and more technical details, just have a look here [teddyCloud](/docs/tools/teddycloud/).
72 changes: 72 additions & 0 deletions content/docs/tools/teddyCloud/tonies-custom-json.md
@@ -0,0 +1,72 @@
---
title: "tonies-custom-json config"
description: "Info about the tonies-custom-json file"
bookCollapseSection: true
---
# tonies.custom.json
Toniecloud uses the tonies-custom-json file 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.

Initially the tonies-custom-json file looks like the following:

```
[]
```

In the gui, a custom tag looks initially like:

_old gui_

![Old GUI](/img/tonies-custom-json_empty_oldgui.png)


_new /web gui_

![New GUI](/img/tonies-custom-json_empty_newgui.png)



With one custom tag the tonies-custom-json file looks like this (more details see below in section [Specification](#specification)):

```
[{"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 GUIs:

_old gui_

![Old GUI](/img/tonies-custom-json_filled_oldgui.png)


_new /web gui_

![New GUI Tonie Cards](/img/tonies-custom-json_filled1_newgui.png)


![New GUI with track display](/img/tonies-custom-json_filled2_newgui.png)


## Specification

The tonies-custom-json file uses the JSON Array Structure. It contains zero, one, or more ordered elements, separated by a comma. The JSON array is surrounded by square brackets [ ].

Each element consists of a JSON object with the following keys:


| Option | Example value | Description |
|----------------|---------------------------------------------------------------------------------------------|-------------|
| no | `"0"` | Number of custom tag |
| model | `""` | A model number of the custom tag, can be left empty |
| audio_id | `["369519776"]` | Enter the custom audio ID of the custom tag. Can be found in the old GUI as shown below |
| hash | `["af9e61a9c1b12138fb060908d595742334b04515"]` | Enter the hash of the custom tag. Can be found in the old GUI as shown below |
| title | `"Custom Tonie Example Title"` | Enter the title of the custom tag, it's currently not displayed, use the series and episode tag to give your custom tag a title which is shown in the GUI |
| series | `"Custom Tonie"` | Enter the Series of the custom tag, will be shown in the GUI |
| episodes | `"This is my custom tonie"` | Enter the Episode of the custom tag, will be shown in the GUI |
| tracks | `["Title 1", "Title 2"]` | Enter the tracks of the custom tag, will be shown in the new GUI only |
| release | `"0"` | currently unused |
| language | `"de-de"` | language code, currently unused |
| category | `"custom"` | category of the custom tag, currently unused |
| pic | `"https://upload.wikimedia.org/wikipedia/en/6/6b/Hello_Web_Series_%28Wordmark%29_Logo.png"` | url of the picture which shall be shown as custom tag image in the GUI |


![Getting the Audio ID and Hash value](/img/tonies-custom-json_sources_audioId_Hash_oldgui.png)
Binary file added static/img/tonies-custom-json_empty_newgui.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/tonies-custom-json_empty_oldgui.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/tonies-custom-json_filled1_newgui.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/tonies-custom-json_filled2_newgui.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/tonies-custom-json_filled_oldgui.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cde8785

Please sign in to comment.