{"id":20645547,"url":"https://github.com/helpfulscripts/hshomesec","last_synced_at":"2025-04-16T02:18:06.016Z","repository":{"id":57267174,"uuid":"141606171","full_name":"HelpfulScripts/hsHomeSec","owner":"HelpfulScripts","description":"A simple home security application, see:","archived":false,"fork":false,"pushed_at":"2020-12-31T22:28:31.000Z","size":990,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-16T02:17:40.169Z","etag":null,"topics":["es6","foscam","home-security","hsdocs","javascript","nodejs","osx","typescript","wansview"],"latest_commit_sha":null,"homepage":"https://helpfulscripts.github.io/hsHomeSec/#!/api/hsHomesec/0","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HelpfulScripts.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-19T16:37:33.000Z","updated_at":"2021-03-16T02:59:07.000Z","dependencies_parsed_at":"2022-08-31T22:01:17.374Z","dependency_job_id":null,"html_url":"https://github.com/HelpfulScripts/hsHomeSec","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HelpfulScripts%2FhsHomeSec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HelpfulScripts%2FhsHomeSec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HelpfulScripts%2FhsHomeSec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HelpfulScripts%2FhsHomeSec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HelpfulScripts","download_url":"https://codeload.github.com/HelpfulScripts/hsHomeSec/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249183119,"owners_count":21226143,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["es6","foscam","home-security","hsdocs","javascript","nodejs","osx","typescript","wansview"],"created_at":"2024-11-16T16:20:20.190Z","updated_at":"2025-04-16T02:18:05.998Z","avatar_url":"https://github.com/HelpfulScripts.png","language":"TypeScript","readme":"hsHomeSec \n========\n[![npm version](https://badge.fury.io/js/hshomesec.svg)](https://badge.fury.io/js/hshomesec)\n[![GitHub](https://img.shields.io/badge/GitHub-hsHomeSec-blue.svg)](https://github.com/helpfulscripts/hsHomeSec)\n[![docs](https://img.shields.io/badge/hsDocs-hsHomeSec-blue.svg)](https://helpfulscripts.github.io/hsHomeSec/#!/api/hsHomeSec/0)\n[![Build Status](https://travis-ci.com/HelpfulScripts/hsHomeSec.svg?branch=master)](https://travis-ci.com/HelpfulScripts/hsHomeSec)\n[![Coverage Status](https://coveralls.io/repos/github/HelpfulScripts/hsHomeSec/badge.svg?branch=master)](https://coveralls.io/github/HelpfulScripts/hsHomeSec?branch=master)\n[![NPM License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://www.npmjs.com/package/hshomesec)\n\nHelpful Scripts simple home security system.\n\n# Home Security System\nA simple homebrew alarm system for OSX High Sierra\n\nWritten in [Typescript](typescriptlang.org) to run on [Node](nodejs.org).\n- supports cameras with built-in web api. Currently tested\n    - WansView Q3S, K3\n    - Foscam C1\n- creates its own ftp server and configures devices to send snapshots and videos there\n- communicates with users via OSX services `Mail`, `Messages`, and `Facetime`\n- simple and universal UI: receives remote user commands via email\n\nSee [documentation for more details](http://helpfulscripts.github.io/hsHomeSec/#!/api/hsHomeSec/0)\n\n## Installation\n1. Create an *install home folder*, `cd` there, and clone the project:\u003cbr\u003e\n`\u003e npm i hshomesec`\u003cbr\u003e\n\n## Setup\n1. Move to the installation folder:\u003cbr\u003e\n`\u003e cd node_modules/hshomesec`\n2. create homeCfg.json from the template:\u003cbr\u003e\n`\u003e cp src/config/homeCfg-template.json src/config/homeCfg.json`\n3. configure `homeCfg.json` with server IPs and available devices (cameras, etc.)\n   \u003e 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.\n4. Configure a valid mail account in `Mail`\n5. Optional: Setup your Mac as follows\n    - select `Desktop \u0026 Screen Saver`, set `Start after:` to `never`\n    - select `Energy Saver`; set `Computer Sleep` to `never`; deselect `Put hard disk to sleep`\n    - install voice `Allison`\n        - open panel `Accessibility-\u003eSpeech`; \n        - select `System Voice: Custom` and select `Allison`. Then close. \n        Voice will be downloaded automatically.\n    - `Terminal-\u003ePreferences-\u003eProfiles-\u003eShell`:\n        - `When the shell exits: Close the window`\n        - `Ask before closing: Never`\n\n## Run\n- From the *install home folder*, call\u003cbr\u003e\n    `\u003e sudo node node_modules/.bin/hsHomeSec`\u003cbr\u003e\n    to start the system without starting an ftp server\n- Or call\u003cbr\u003e\n    `\u003e sudo node node_modules/.bin/hsHomeSec ftp`\u003cbr\u003e\n    to start the system with its own ftp server. The ftp server is needed \n    by some devices to store snaphots and recordings in case an alarm is \n    detected.\n    \u003e You can try the calls without `sudo`, though it is likely needed since we start an ftp server (if selected). \n    The webserver lets Mail (via Applescript) tell the system about incoming user commands.\n\n## Operations\n- send an email to the mail account configured in step 4 above.\n- ensure that the mail address you send it from is configured as `User` in `homeCfg.json`. A `403` error will be returned if not.\n- issue commands via the mail's subject field. For example:\n   - `snap` will return a snapshot from each attached camera\n   - `help` will return a list of available commands.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelpfulscripts%2Fhshomesec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhelpfulscripts%2Fhshomesec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelpfulscripts%2Fhshomesec/lists"}