Skip to content

Commit 7f93d04

Browse files
henryk86henryk86
committed
overworked wiki, added customized tonieboxes json help
1 parent 2cd767f commit 7f93d04

5 files changed

+61
-4
lines changed

‎content/docs/tools/teddyCloud/supported-server-hardware.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,18 @@ Below is a compilation of NAS/server hardware that has been successfully utilize
1313
| Raspberry Pi 4 | - |
1414
| Raspberry Pi Zero 2 | slow on initial startup (expect 20 minutes and more for initial certificate creation!), encoding also very slow, possible crashes in some situations, but in general usable |
1515
| Synology NAS DS923+ (DSM 7.2.1) | - |
16+
| Raspberry Pi Zero | Docker installation a little bit tricky, see https://forum.revvox.de/t/hardware-requirements-does-teddycloud-run-on-a-raspberry-zero-1st-gen/309 |
1617
| ... | |
1718

19+
Consider using Alpine container instead of Ubuntu / Debian container if your server has limited resources.
20+
1821
If you're utilizing alternative NAS/server hardware configurations, your contribution is welcome. Feel free to share your experience and insights with the community.
1922

2023
## Tested Hardware, but not supporting TeddyCloud
2124

2225

23-
| NAS / Server hardware | Comment/Discussion/Links |
24-
|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
25-
| Raspberry Pi Zero | Probably more of a Docker compatibility issue than TeddyCloud related, see https://forum.revvox.de/t/hardware-requirements-does-teddycloud-run-on-a-raspberry-zero-1st-gen/309 |
26+
| NAS / Server hardware | Comment/Discussion/Links |
27+
|-----------------------|--------------------------|
28+
| ... | |
2629

2730
If you've attempted to deploy TeddyCloud on specialized hardware without success, we encourage you to share your experience for community contribution. Conversely, if you've successfully implemented TeddyCloud on any of the mentioned hardware platforms, we invite you to document your process on our forum. Additionally, you're welcome to transition your system to one of the officially supported configurations.

‎content/docs/tools/teddyCloud/tonies-custom-json.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Enriched with metadata for the above shown custom tag the tonies-custom-json fil
2929
[{"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"}]
3030
```
3131

32-
This results after restart of teddycloud in the following changed appearance in the GUIs:
32+
This results after restart of TeddyCloud in the following changed appearance in the GUIs:
3333

3434
_old gui_
3535

‎content/docs/tools/teddyCloud/toniesboxes-custom-json.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: "tonieboxes-custom-json"
3+
description: "Info about the toniesboxes.custom.json file"
4+
bookCollapseSection: true
5+
---
6+
# tonieboxes.custom.json
7+
TeddyCloud uses the tonieboxes-custom-json file to read the metadata of customized tonieboxes in the same manner it's done for the official boxine tonieboxes in the tonieboxes-json file. The structure is the same, but it's not overwritten as the tonieboxes-json file through possible updates. So you can use the tonieboxes-custom-json to save metadata of your own customized Tonieboxes.
8+
9+
Initially the tonieboxes-custom-json file looks like the following:
10+
11+
```
12+
[]
13+
```
14+
15+
After adding the meta information of your customized Toniebox the tonieboxes-custom-json file looks like this (more details see below in section [Specification](#specification)):
16+
17+
```
18+
[{
19+
"id": "11-0001",
20+
"name": "Customized Toniebox Teddycloud Limited Edition",
21+
"img_src": "http://teddycloud.local/customToniebox.png",
22+
"crop": [
23+
0,
24+
0,
25+
1
26+
]
27+
}]
28+
```
29+
30+
This results after restart of TeddyCloud in the following changed appearance in the GUI:
31+
32+
_new /web gui_
33+
Edit Box model modal:
34+
35+
![New GUI Toniebox Modal](/img/tonieboxes-custom-json-file-editModel.png)
36+
37+
Toniebox Card:
38+
39+
![New GUI Toniebox Cards](/img/tonieboxes-custom-json-file-customizeTonieboxCard.png)
40+
41+
42+
## Specification
43+
44+
The tonieboxes-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 [ ].
45+
46+
Each element consists of a JSON object with the following keys:
47+
48+
49+
| Option | Example value | Description |
50+
|---------|----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
51+
| id | `"11-0001"` | Model number (must be not one of the existing model numbers! |
52+
| name | `"Customized Toniebox Teddycloud Limited Edition"` | Name of the customized Toniebox |
53+
| img_src | `"http://teddycloud.local/customToniebox.png"` | url of the picture which shall be shown as customized Toniebox image in the GUI |
54+
| crop | `[0,0,1]` | Array of 3 elements: [x, y, scale] with x and y as Image shift in x / y direction, scale as factor for scaling the image. Try the correct values till the image has the right size and it's placed correctly. |

‎static/img/tonieboxes-custom-json-file-customizeTonieboxCard.png

540 KB
Loading

‎static/img/tonieboxes-custom-json-file-editModel.png

50.1 KB
Loading

0 commit comments

Comments
 (0)