Skip to content

Latest commit

 

History

History
executable file
·
245 lines (191 loc) · 9.26 KB

README.md

File metadata and controls

executable file
·
245 lines (191 loc) · 9.26 KB
Raw

camera-polyglot

This is the Camera Poly for the ISY Polyglot interface.
(c) JimBoCA aka Jim Searle MIT license.

This node server is intended to support any type of camera. Currently the following are supported:

  1. Foscam MJPEG This is any Foscam Camera MJPEG camera. This should be any camera that uses this interface Foscam IP Camera CGI which includes the non-HD Smarthome INSTEON cameras that are rebranded Foscam's.
  • See README_foscam.md for more information
  • All the params are documented in the pdf mentioned above, if you have questions about them, please read that document first.
  • The 'IR LED' only has a set option, and does not display the status because it seems there is no way to get the status of this from the camera that I can find. If you know how, please tell me!
  • The 'Network LED Mode' is the led_mode from the camera which is defined as:
    • led_mode=0 : LED indicates network connection
    • led_mode=1 : LED indicates connected network type
    • led_mode=2 : LED deactivated except during camera boot

  1. FoscamHD2 (H.264) Any Camera that uses the interface Foscam IPCamera CGI User Guide To use the Goto preset control you must defined presets named "1", "2", "3", ... on the camera. I would like to support using the preset names defined on the camera but that would require creating the profile.zip on the fly which is possible, but hasn't been done yet.

    Tested with:

    Camera Model System Version
    FI9828P V2 1.4.1.10
    FI9826P V2 1.5.3.19

  2. Amcrest This uses the https://github.com/tchellomello/python-amcrest python library to control the camera so any that work with that interace should work. Currently there is no discovery for this cameras so you need to add them to the config

Config Format

The default config.yaml is automatically created in the Install procedure step #2, and will contain a generic settings for uername and password. Currently you must use the same username and password on all camers. The format is as follows:

user: your_user_name
password: your_password

cameras:
  - host: 192.168.86.120
    type: Amcrest1

The cameras section is not needed for foscam cameras, to add more cameras just duplicate the host and type lines for each one.

Requirements

  1. Currently you must be running at least the unstable-rc version of polyglot. You must grab the uncompiled version as instructed here: https://github.com/UniversalDevicesInc/Polyglot/wiki/Polyglot-README#to-run-the-python-module-non-compiled-version Then also switch to the unstable-rc branch before running polyglot with git checkout unstable-rc when in the checked out Polyglot directory. But, if you are using another node server you pulled down from github, it may not yet be compatible so check with the Author before switching to this version!
  2. This has only been tested on the ISY 5.0.2 Firmware.
  3. Install required python modules as instructed in Install Step #1

Install

Install:

  1. Pull the camera-polyglot into Polyglot
  • cd polyglot/config/node_servers
  • git clone https://github.com/jimboca/camera-polyglot.git
  • cd camera-polyglot
  • sudo pip install -r requirements.txt
  1. From the polyglot web page: http://your.pi.ip:8080
  • Refresh the page
  • Select 'Add Node Server'
  • Select 'IP Camera' as the 'Node Server Type'
  • Enter a name.
  • Enter a Node Server ID. This MUST be the same 'Node Server' slot you intend to use from the ISY!!!
  • Click Add, and it should show up on the left hand side and show 'Running', at least for a few seconds.
  1. If this is the first time, it will create a configuration file for you and will die with a message like ERROR [04-17-2016 20:06:07] polyglot.nodeserver_manager: camera: IOError: Created default config file, please edit and set the proper values "/home/pi/Polyglot/config/camera-polyglot/config.yaml"
  • You can view the Polyglot log from the web page by clicking the 'View Log' icon.
  • Edit this config file on your Rpi and set the username and password for your camera(s).
  • If you have Amcrest cameras, add your cameras with host and type.
  1. Go back to the Polyglot web page:
  • Click on the camera node server on the left of the page
  • Click on the 'Restart Server'
  • The server should stay 'Running' now.
  • Click on the 'Download profile' icon.
  • Select and Copy the 'Base URL' from that page, which you will need for Pasting later.
  1. Add as NodeServer in ISY by selecting the empty slot that matches 'Node Server ID' you used in Step 2.
  • Set 'Profile Name' to whatever you want, but might as well be the same as the name used in Step 2.
  • Set the Polyglot 'User Id' and Password. Default: admin & admin.
  • Paste the 'Base URL' you copied in Step 4.
  • Set Host Name or IP of your machine running Polyglot
  • Set Port to the Polyglot port, default=8080
  1. Click 'Upload Profile'
  • Browse to where the 'camera_profile.zip' from Step 4 is located and select it.
  1. Reboot ISY
  2. Upload Profile again in the node server (quirk of ISY)
  3. Reboot ISY again (quirk of ISY)
  4. Once ISY is back up, go to Polyglot and restart the Camera node server.
  5. You should now have a 'Camera Server' node in the ISY.
  • Select the node
  • Set 'Foscam MJPEG Search' to '10s Query'
  • Set 'Debug' to 'Debug'
  • Click on 'Discover'
  • After about 30 seconds it should have found and added any camera.
  1. Write programs and enjoy.

Update

To update, go to where you grabbed camera-polyglot and update:

  1. cd camera-polyglot
  2. git pull
  3. Go to polyglot web page and Restart Server

If the update has profile changes, then download the new profile from the Polyglot web page, and upload the profile into your node server on the ISY.

Debugging

This node server creates a log file as Polyglot/config/camera-polyglot/camera.log, where 'camera' is what you called the node server in Polyglot. If you have any issues, first review that file, and also look for Errors with 'grep ERROR camera.log'.

Programs

Create programs on the ISY to monitor the Camera Server.

  1. First create a state variable s.Polyglot.CamServer, or whatever you want to call it.

  2. Create all the following programs

    • I put them all in a subfolder:
    ===========================================
    Polyglot - [ID 025B][Parent 0001]

    Folder Conditions for 'Polyglot'

    If
       - No Conditions - (To add one, press 'Schedule' or 'Condition')
 
    Then
       Allow the programs in this folder to run.
  • Heartbeat Monitor
    -------------------------------------------
    CamS - [ID 025C][Parent 025B]

    If
        'Camera Server' is switched On
 
    Then
        $s.Polyglot.CamServer  = 1
        Wait  5 minutes 
        $s.Polyglot.CamServer  = 2
 
    Else
        $s.Polyglot.CamServer  = 2
 
    Watch for CamS DON, wait 5 minutes and set error if not seen.
  • Okay notification
    -------------------------------------------
    CamS Okay - [ID 0260][Parent 025B]

    If
        $s.Polyglot.CamServer is 1
 
    Then
        Send Notification to 'Pushover-P1' content 'Polyglot Status'
 
    This will be sent when CamS status is changed from anything to 1.
    Which means it will be sent when a problem is fixed, or ISY is starting up.
  • Problem Notification
    -------------------------------------------
    CamS Problem - [ID 025D][Parent 025B]

    If
        $s.Polyglot.CamServer is 2
 
    Then
        Send Notification to 'Pushover-P1' content 'Polyglot Status'
 
    CamS status 2 is a problem, send notification.
  • Daily Problem reminder
    -------------------------------------------
    CamS Problem Reminder - [ID 025F][Parent 025B]

    If
        $s.Polyglot.CamServer is 2
    And (
             Time is  8:00:00AM
          Or Time is  6:00:00PM
        )
 
    Then
        Send Notification to 'Pushover-P1' content 'Polyglot Status'
 
    CamS status 2 is a problem, send notification every day.
  • Startup action
    -------------------------------------------
    CamS Startup - [ID 025E][Parent 025B]

    If
        $s.Polyglot.CamServer is 0
 
    Then
        Run Program 'CamS' (Then Path)
 
    CamS init is zero, which only happens at startup, so start watching the CamS.
  1. Create a custom notification 'Polyglot Status':
Subject: ISY: Polyglot Status
Body:
CameraServer Status: ${var.2.155}
0: Not initialized
1: Okay
2: Not responding

Release Notes:

  • 0.10.0:
    • Initial release of Amcrest
  • 0.9.0:
  • 0.8.1:
    • Remove reference to python foscam library which is not used
    • Added comments about preset names in README.
  • 0.8.0:
    • Added support for Foscam H.264 Cameras
    • Removed sending of DON every minute, until latest Polyglot development version is released.
    • Must upload new profile
  • 0.7.3:
  • 0.2
    • (beta) of the Polyglot Camera NodeServer