Skip to content

Commit bae8492

Browse files
SciLorSciLor
authored
Merge pull request #30 from henryk86/master
Added Teddycloud Hardware support page
2 parents e1bf872 + 849bd7e commit bae8492

File tree

6 files changed

+88
-6
lines changed

6 files changed

+88
-6
lines changed

‎content/docs/tools/teddyCloud/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ bookCollapseSection: true
88
## Features
99
teddyCloud is an alternative server for your Toniebox, allowing you to host the cloud services locally.
1010
This gives you the control about which data is sent to the original manufacturer's cloud and allows you
11-
to host your own figurine audio files on e.g. your NAS or any other server.
11+
to host your own figurine audio files on e.g. your [NAS or any other server](supported-server-hardware.md).
1212
You can also use teddyCloud on the command line to manipulate esp32 firmware dumps or encode Tonie Audio Files (TAFs). See ```toniecloud --help```.
1313

1414
## Docker hints

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

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: "Supported NAS/Server hardware"
3+
description: "list of supported NAS/server hardware (incomplete)"
4+
bookCollapseSection: true
5+
---
6+
# Supported NAS/Server hardware
7+
8+
Teddycloud is supported on nearly all servers utilizing the x86_64, arm64, and armhf (linux/arm/v7) architectures, as Docker containers are available for these platforms.
9+
Below is a compilation of NAS/server hardware that has been successfully utilized to host TeddyCloud:
10+
11+
| NAS / Server hardware | Limitations |
12+
|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
13+
| Raspberry Pi 4 | - |
14+
| 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 |
15+
| Synology NAS DS923+ (DSM 7.2.1) | - |
16+
| Raspberry Pi Zero | Docker installation is a little bit tricky, getting it running could take some extra steps see https://forum.revvox.de/t/hardware-requirements-does-teddycloud-run-on-a-raspberry-zero-1st-gen/309 |
17+
| ... | |
18+
19+
Consider using Alpine container instead of Ubuntu / Debian container if your server has limited resources.
20+
21+
If you're utilizing alternative NAS/server hardware configurations, your contribution is welcome. Feel free to share your experience and insights with the community.
22+
23+
## Tested Hardware, but not supporting TeddyCloud
24+
25+
26+
| NAS / Server hardware | Comment/Discussion/Links |
27+
|-----------------------|--------------------------|
28+
| ... | |
29+
30+
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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Info about the tonies-custom-json file"
44
bookCollapseSection: true
55
---
66
# tonies.custom.json
7-
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.
7+
TeddyCloud 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.
88

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

@@ -23,15 +23,13 @@ _new /web gui_
2323

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

26-
27-
28-
With one custom tag the tonies-custom-json file looks like this (more details see below in section [Specification](#specification)):
26+
Enriched with metadata for the above shown custom tag the tonies-custom-json file looks like this (more details see below in section [Specification](#specification)):
2927

3028
```
3129
[{"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"}]
3230
```
3331

34-
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:
3533

3634
_old gui_
3735

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

Lines changed: 54 additions & 0 deletions
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)