hsHomeSec
Helpful Scripts simple home security system.
Home Security System
A simple homebrew alarm system for OSX High Sierra
Written in Typescript to run on Node.
- supports cameras with built-in web api. Currently tested
- WansView Q3S, K3
- Foscam C1
- creates its own ftp server and configures devices to send snapshots and videos there
- communicates with users via OSX services
Mail
,Messages
, andFacetime
- simple and universal UI: receives remote user commands via email
See documentation for more details
Installation
- Create an install home folder,
cd
there, and clone the project:
> npm i hshomesec
Setup
- Move to the installation folder:
> cd node_modules/hshomesec
- create homeCfg.json from the template:
> cp src/config/homeCfg-template.json src/config/homeCfg.json
- configure
homeCfg.json
with server IPs and available devices (cameras, etc.)It may be a good idea to also configure your DHCP server to assign fixed addresses to the computer running the homeSec server, as well as to connected devices.
- Configure a valid mail account in
Mail
- Optional: Setup your Mac as follows
- select
Desktop & Screen Saver
, setStart after:
tonever
- select
Energy Saver
; setComputer Sleep
tonever
; deselectPut hard disk to sleep
- install voice
Allison
- open panel
Accessibility->Speech
; - select
System Voice: Custom
and selectAllison
. Then close. Voice will be downloaded automatically.
- open panel
Terminal->Preferences->Profiles->Shell
:When the shell exits: Close the window
Ask before closing: Never
- select
Run
- From the install home folder, call
> sudo node node_modules/.bin/hsHomeSec
to start the system without starting an ftp server - Or call
> sudo node node_modules/.bin/hsHomeSec ftp
to start the system with its own ftp server. The ftp server is needed by some devices to store snaphots and recordings in case an alarm is detected.You can try the calls without
sudo
, though it is likely needed since we start an ftp server (if selected). The webserver lets Mail (via Applescript) tell the system about incoming user commands.
Operations
- send an email to the mail account configured in step 4 above.
- ensure that the mail address you send it from is configured as
User
inhomeCfg.json
. A403
error will be returned if not. - issue commands via the mail's subject field. For example:
snap
will return a snapshot from each attached camerahelp
will return a list of available commands.