Skip to content
Snippets Groups Projects
Commit 10f73162 authored by David Huss's avatar David Huss :speech_balloon:
Browse files

Update readme

parent 0e0af4ea
Branches
No related tags found
No related merge requests found
...@@ -23,7 +23,7 @@ A stechuhr client consists of: ...@@ -23,7 +23,7 @@ A stechuhr client consists of:
- 1x M301 Mifare Card Reader with USB _mini_ B - 1x M301 Mifare Card Reader with USB _mini_ B
- 1x USB mini B to USB A cable - 1x USB mini B to USB A cable
- 1x short RJ-45 patch cable - 1x short RJ-45 patch cable
- **TODO:** Add Speaker/Buzzer to additionally allow for acoustic feedback as demanded by security personal, maybe make this switchable via config/toggle switch to avoid annoying people? - (Optional): Speaker/Buzzer to additionally allow for acoustic feedback, switchable via config/toggle switch to avoid annoying people
| without raspi + reader | | without raspi + reader |
| ---- | | ---- |
...@@ -38,16 +38,17 @@ A stechuhr client consists of: ...@@ -38,16 +38,17 @@ A stechuhr client consists of:
| Network | Neutrik Network connector | Raspi Network Connector | Short RJ-45 Patch cable | | Network | Neutrik Network connector | Raspi Network Connector | Short RJ-45 Patch cable |
| Mifare Reader | USB A jack Raspi | USB mini B jack Mifare reader | USB-A to USB mini-B cable | | Mifare Reader | USB A jack Raspi | USB mini B jack Mifare reader | USB-A to USB mini-B cable |
| LED module 5V | Raspi GPIO 5V | 5V WS2812 Module (if more than 1 LED is used consider connecting this to the external PSU 5V) | Jumpercable with female pinheader on one side, soldered on the other | | LED module 5V | Raspi GPIO 5V | 5V WS2812 Module (if more than 1 LED is used consider connecting this to the external PSU 5V) | Jumpercable with female pinheader on one side, soldered on the other |
| LED module GND | Raspi GPIO GND | 5V WS2812 Module | Jumpercable with female pinheader on one side, soldered on the other | | LED module GND | Raspi GPIO GND | GND WS2812 Module | Jumpercable with female pinheader on one side, soldered on the other |
| LED module PWM | Raspi GPIO 10 | D2 WS2812 Module | Jumpercable with female pinheader on one side, soldered on the other | | LED module PWM | Raspi GPIO 10 | D2 WS2812 Module | Jumpercable with female pinheader on one side, soldered on the other |
| Buzzer + | Raspi 5V | Buzzer + | Jumpercable with female pinheader on one side, soldered on the other | | Buzzer + | Raspi 5V | Buzzer + | Jumpercable with female pinheader on one side, soldered on the other |
| Buzzer - | Buzzer Amp Module | See drawing | | | Buzzer - | Buzzer Amp Module | See drawing | |
| Buzzer Amp GND | Raspi GND | See drawing | | | Buzzer Amp GND | Raspi GND | See drawing | |
| Buzzer Amp Signal | Raspi GPIO 18 | See drawing | | | Buzzer Amp Signal | Raspi GPIO 18 | See drawing | |
![](images/gpio.png) ![](images/gpio.png)
^ GPIO for RASPI v1 (!)
![](images/buzzer-amp.jpg) ![](images/buzzer-amp.jpg)
Resistor is 100k Resistor is 100k
...@@ -105,7 +106,7 @@ journalctl -fu stechuhr ...@@ -105,7 +106,7 @@ journalctl -fu stechuhr
## Todo ## Todo
- [ ] Blink red forever if server cannot be reached - [ ] Blink red forever if server cannot be reached
- [ ] Add acoustic feedback - [x] Add acoustic feedback
## Configuration ## Configuration
...@@ -126,7 +127,7 @@ in `config.toml` there are three keys that identify a stechuhr.: ...@@ -126,7 +127,7 @@ in `config.toml` there are three keys that identify a stechuhr.:
### ID verification ### ID verification
in `config.toml` you can add a list of regex patterns that stechuhr (*both on server and on client!*) uses to verify the Card IDs. These two patterns for example allow upper/lowercase hex strings with lengths either between 6 and 16 characters OR exactly 24 characters: in `config.toml` you can add a list of regex patterns that stechuhr (*both on server and on client!*) uses to verify the Card IDs. The client will request the patterns from the server at start up and periodically thereafter (which allows you to use a server config to update these lists). These two patterns for example allow upper/lowercase hex strings with lengths either between 6 and 16 characters OR exactly 24 characters:
```toml ```toml
id_patterns = [ id_patterns = [
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment