-
Notifications
You must be signed in to change notification settings - Fork 47
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
optimize readme and adding changelog
- Loading branch information
1 parent
a41a1d6
commit cfe63ed
Showing
6 changed files
with
109 additions
and
186 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# 2.0.0 (2023-10-01) | ||
|
||
## Breaking Changes | ||
|
||
- Following Settings have changed and are breaking changes | ||
- `cascade` - chnage default path according to the new folder structure | ||
- `encodings` - chnage default path according to the new folder structure | ||
- `usePiCamera` and `source` - not avialable anymore because of auto-detection with `picamera2` library | ||
- `brightness` - new possible values are 0-100 | ||
- `contrast` - new possible values are 0-127 | ||
- `rotateCamera` - new possible values are -1 = no rotation, 0 = 90°, 1 = 180°, 2 = 270° | ||
- `pythonPath` - still works if you like to use it, but it is not necessary anmore with pipenv | ||
- `resolution` - default resolution was changed from `[1280, 960]` to `[1920,1080]` | ||
- Some old OS images are not supported anymore according to `picamera2` | ||
|
||
### Folder structure | ||
|
||
- Move haarcascade from `tools` to `model` | ||
- `encodings.pickle` is now by default in folder `model` | ||
- `Dockerfile` was removed because of new simple setup | ||
- `Makefile` was removed because of new simple setup | ||
- `facerecognition.py` was renamed to `recognition.py` | ||
- Split `recognition.py` functions into mulitple utils files | ||
|
||
### pipenv | ||
|
||
- To be sure everything is installed what is needed for this module we | ||
implemented pipenv and add all dependencies automaticly with pip and pipenv. | ||
It will be installed after `npm install`. | ||
|
||
### Camera support | ||
|
||
- We use the new `picamera2` library to read the camera image. It should support | ||
all the picameras and some third party cameras. | ||
|
||
### OS support | ||
|
||
- Because we use the `picamera2` libary, we support Raspberry Pi OS Bullseye (or later) 32bit and 64bit. | ||
|
||
- Picamera2 is not supported on: | ||
- Images based on Buster or earlier releases. | ||
- Raspberry Pi OS Legacy images. | ||
- Bullseye (or later) images where the legacy camera stack has been re-enabled. | ||
|
||
### NPM scripts | ||
|
||
- We have new npm scripts which helps to setup the module | ||
- `npm run encode` | ||
- `npm run recognition` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.