Skip to content

Commit 6f8a62c

Browse files
committed
Update Docs
1 parent ef52637 commit 6f8a62c

File tree

5 files changed

+115
-42
lines changed

5 files changed

+115
-42
lines changed

docs/.vitepress/config/de.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
9393
text: 'Einführung',
9494
items: [
9595
{ text: 'Was ist Doorman?', link: 'what-is-doorman' },
96-
{ text: 'Kann ich Doorman verwenden?', link: 'hardware-compatibility' },
96+
{ text: 'Kann ich den verwenden?', link: 'hardware-compatibility' },
9797
{ text: 'Erste Schritte', link: 'getting-started' }
9898
]
9999
},

docs/.vitepress/theme/Layout.vue

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
<script setup lang="ts">
2+
import { useData } from 'vitepress'
3+
import DefaultTheme from 'vitepress/theme'
4+
import { nextTick, provide } from 'vue'
5+
6+
const { isDark } = useData()
7+
8+
const enableTransitions = () =>
9+
'startViewTransition' in document &&
10+
window.matchMedia('(prefers-reduced-motion: no-preference)').matches
11+
12+
provide('toggle-appearance', async ({ clientX: x, clientY: y }: MouseEvent) => {
13+
if (!enableTransitions()) {
14+
isDark.value = !isDark.value
15+
return
16+
}
17+
18+
const clipPath = [
19+
`circle(0px at ${x}px ${y}px)`,
20+
`circle(${Math.hypot(
21+
Math.max(x, innerWidth - x),
22+
Math.max(y, innerHeight - y)
23+
)}px at ${x}px ${y}px)`
24+
]
25+
26+
await document.startViewTransition(async () => {
27+
isDark.value = !isDark.value
28+
await nextTick()
29+
}).ready
30+
31+
document.documentElement.animate(
32+
{ clipPath: isDark.value ? clipPath.reverse() : clipPath },
33+
{
34+
duration: 300,
35+
easing: 'ease-in',
36+
pseudoElement: `::view-transition-${isDark.value ? 'old' : 'new'}(root)`
37+
}
38+
)
39+
})
40+
</script>
41+
42+
<template>
43+
<DefaultTheme.Layout />
44+
</template>
45+
46+
<style>
47+
::view-transition-old(root),
48+
::view-transition-new(root) {
49+
animation: none;
50+
mix-blend-mode: normal;
51+
}
52+
53+
::view-transition-old(root),
54+
.dark::view-transition-new(root) {
55+
z-index: 1;
56+
}
57+
58+
::view-transition-new(root),
59+
.dark::view-transition-old(root) {
60+
z-index: 9999;
61+
}
62+
63+
.VPSwitchAppearance {
64+
width: 22px !important;
65+
}
66+
67+
.VPSwitchAppearance .check {
68+
transform: none !important;
69+
}
70+
</style>

docs/.vitepress/theme/index.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
import DefaultTheme from "vitepress/theme";
2+
import Layout from './Layout.vue'
23
import "./custom.css";
34

4-
export default DefaultTheme;
5+
export default {
6+
extends: DefaultTheme,
7+
// override the Layout with a wrapper component that
8+
// injects the slots
9+
Layout: Layout
10+
}

docs/de/guide/hardware-compatibility.md

Lines changed: 36 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,70 @@
1-
# Can I use Doorman?
2-
If your [TCS](https://www.tcsag.de/) or [Koch](https://www.kochag.ch/) intercom has `a`, `b`, and `P` labeled screw terminals and operates on 24V DC, it's likely compatible.
1+
### Kann ich Doorman benutzen?
32

4-
Some rebranded [Niko](https://www.niko.eu/) and [Scantron](https://scantron.dk/) intercoms, which are counterparts to the TCS and Koch models, may also be compatible.
3+
Wenn deine [TCS](https://www.tcsag.de/) oder [Koch](https://www.kochag.ch/) Gegensprechanlage die Anschlussklemmen `a`, `b` und `P` hat und mit 24V DC betrieben wird, ist sie wahrscheinlich kompatibel.
54

6-
:::danger READ - BEFORE YOU ORDER
7-
Since this product is the result of reverse engineering, there is no guarantee that your intercom will work without testing it yourself.
5+
Einige umgelabelte [Niko](https://www.niko.eu/) und [Scantron](https://scantron.dk/) Gegensprechanlagen, die den TCS- und Koch-Modellen entsprechen, könnten ebenfalls passen.
86

9-
1. Check the wiring and measure the voltage before ordering a Doorman.
7+
:::danger WICHTIG - BEVOR DU BESTELLST
8+
Da dieses Produkt durch Reverse Engineering entwickelt wurde, gibt es keine Garantie, dass deine Sprechanlage ohne Tests funktioniert.
109

11-
2. There is no guarantee that Doorman will work with your intercom due to the unique wiring in each building.
10+
1. Überprüfe die Verkabelung und miss die Spannung, bevor du Doorman bestellst.
11+
2. Es gibt keine Garantie, dass Doorman mit deiner Gegensprechanlage funktioniert, da die Verkabelung in jedem Gebäude einzigartig ist.
12+
3. Andere Geräte an der `P`-Leitung (z.B. Geräte deiner Nachbarn) könnten zu viel Strom ziehen und Doorman beeinträchtigen.
1213

13-
3. Other devices on the `P`-line (e.g., your neighbors' equipment) may draw too much current, potentially affecting Doorman's performance.
14-
15-
**Understand these risks before purchasing.** If you have any questions, please contact me, and I will be happy to help!
14+
**Verstehe diese Risiken, bevor du einen bestellst.** Wenn du Fragen hast, kontaktiere mich gerne und ich helfe dir weiter!
1615
:::
1716

18-
## Wiring
19-
**2-Wire Mode:**\
20-
If your intercom is connected in 2-wire mode and you don't have a separate 24V `P`-line, use an external power supply via USB-C or the `P` (+5V to +30V DC) and `b` (Ground) screw terminals.
17+
## Verkabelung
18+
**2-Draht-Modus:**\
19+
Wenn deine Gegensprechanlage im 2-Draht-Modus angeschlossen ist und du keine separate 24V `P`-Leitung hast, verwende eine externe Stromversorgung über USB-C oder die Schraubklemmen `P` (+5V bis +30V DC) und `G` (Ground).
2120

22-
**3-Wire Mode:**\
23-
If connected in 3-wire mode, you should be able to use the `P`-line to power your Doorman in most cases.
21+
**3-Draht-Modus:**\
22+
Wenn sie im 3-Draht-Modus angeschlossen ist, solltest du in den meisten Fällen die `P`-Leitung zur Stromversorgung vom Doorman nutzen können.
2423

2524
::: tip
26-
In some installations, the `a` and `b` wires are twisted, but this is handled by Doorman’s integrated bridge rectifier. Consider this when checking the voltage levels on the `a`, `b`, and `P` lines.
25+
In einigen Installationen sind die `a`- und `b`-Drähte verdreht, aber das wird von Doormans integriertem Brückengleichrichter berücksichtigt. Berücksichtige dies beim Überprüfen der Spannung auf den Leitungen `a`, `b` und `P`.
2726
:::
2827

29-
#### Intercom Screw Terminal Explanation
30-
- **a:** Typically the Bus line (+24V)
31-
- **b:** Typically Ground
32-
- **P:** The +24V line in 3-wire mode or the apartment doorbell button in 2-wire mode
28+
#### Erklärung der Gegensprechanlagen-Anschlussklemmen
29+
- **a:** Typischerweise die Bus-Leitung (+24V)
30+
- **b:** Typischerweise Ground
31+
- **P:** Die +24V-Leitung im 3-Draht-Modus oder der Klingelknopf der Wohnung im 2-Draht-Modus
3332

3433
::: danger
35-
**DO NOT USE THE +24V `P`-LINE AND USB-C AT THE SAME TIME**
34+
**NICHT GLEICHZEITIG DIE +24V `P`-LEITUNG UND USB-C VERWENDEN**
3635
:::
3736

38-
## Check the Power Supply
39-
Use a multimeter to check the DC voltage.\
40-
Measure the polarity first since the `a` and `b` lines can be twisted.
41-
42-
#### Expected Voltage
43-
- Between `a` and `b`: ~ 24.0V
44-
- Between `P` and `b`: ~ 23.2V
37+
## Überprüfe die Stromversorgung
38+
Verwende ein Multimeter, um die DC-Spannung zu messen.\
39+
Miss zuerst die Polarität, da die `a`- und `b`-Leitungen verdreht sein können.
4540

41+
#### Erwartete Spannung
42+
- Zwischen `a` und `b`: ~ 24,0V
43+
- Zwischen `P` und `b`: ~ 23,2V
4644

4745
::: warning
48-
The intercom power supply **must have a minimum output current of 60mA** for stable operation.
46+
Die Stromversorgung der Gegensprechanlage **muss mindestens 60mA Ausgangsstrom liefern**, um stabil zu funktionieren.
4947

50-
If other devices using the `P`-line draw too much current, it may not be sufficient to power Doorman.
48+
Wenn andere Geräte an der `P`-Leitung zu viel Strom ziehen, reicht es möglicherweise nicht aus, um Doorman zu betreiben.
5149

52-
**Use an external power supply (USB-C or screw terminal) if your intercom’s power supply provides less than 60mA or if you notice unstable operation.**
50+
**Verwende eine externe Stromversorgung (USB-C oder Schraubklemme), wenn die Stromversorgung deiner Sprechanlage weniger als 60mA liefert oder wenn du eine instabile Funktion bemerkst.**
5351
:::
5452

55-
## Known Issues
53+
## Bekannte Probleme
5654

57-
Some intercom phones with a TTC1-B-1 connector module cause issues because the `a` and `P` connectors are somehow connected. It is not yet clear which models are affected.
55+
Einige Gegensprechanlagen mit einem TTC1-B-1 Anschlussmodul verursachen Probleme, da die `a`- und `P`-Anschlüsse irgendwie verbunden sind.
56+
Welche Modelle betroffen sind, ist noch unklar.
5857

5958
::: danger Problem
60-
A loud beeping noise occurs whenever someone is talking.
59+
Es tritt ein lautes Piepen auf, wenn jemand spricht.
6160
:::
6261

6362
![ttc1-b-1-module](./images/incompatible-ttc1-b-1.png){width=300px}
6463

64+
## Verifizierte Modelle
6565

66-
67-
## Verified Hardware
68-
69-
::: info Note
70-
If your intercom phone isn't listed here, it doesn’t necessarily mean it’s incompatible; it simply means it hasn’t been tested yet.
66+
::: info Hinweis
67+
Wenn deine Gegensprechanlage hier nicht aufgeführt ist, bedeutet das nicht unbedingt, dass sie nicht kompatibel ist; es heißt nur, dass sie noch nicht getestet wurde.
7168
:::
7269

7370
- TCS BVS20-SG / Koch BVS20

docs/de/guide/what-is-doorman.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Du kannst ihn auch verwenden, um einen Tastendruck zu simulieren und damit einen
1010

1111
Wenn deine Gegensprechanlage auf einem 2-Draht-Bus im Bereich von 14-24V DC arbeitet, könnte es möglich sein, auch andere Protokolle zu implementieren.
1212

13-
Alternativ kannst du den Spannungspegel auf älteren Gegensprechanlagen (14-24V DC) [mithilfe des internen ADC überwachen](firmware/stock-firmware#advanced-examples) und spezifische Aktionen basierend auf den Messwerten auslösen.
13+
Alternativ kannst du den Spannungspegel auf älteren Gegensprechanlagen (14-24V DC) [mithilfe des internen ADC überwachen](firmware/stock-firmware#fortgeschrittene-beispiele) und spezifische Aktionen basierend auf den Messwerten auslösen.
1414

1515
<div class="tip custom-block" style="padding-top: 8px">
1616

0 commit comments

Comments
 (0)