Metadata-Version: 2.1
Name: libhttpcam
Version: 0.1.3
Summary: Accessing webcams via REST API
Home-page: https://github.com/HelpfulScripts/libhttpcam
Author: Helpful Scripts
Author-email: helpfulscripts@gmail.com
License: UNKNOWN
Description: # Web Cam Access via HTTP REST-API
        
        A Python3 library that unified acess to various web cams with integrated HTTP servers.
        The intended use is for connecting cameras with built-in REST servers to the 
        [home-assistant](https://www.home-assistant.io/) platform.
        
        ## Installation
        ### libhttpcam
            pip3 install libhttpcam
        or as update:
        
            pip3 install --upgrade libhttpcam 
        
        ## Usage
        Use `createCam` to create a camera instance.
        
            from libhttpcam import createCam
        
            model = 'foscam'
            ip = '10.0.0.30'
            cam, port = createCam('foscam', ip)  # use model's default port
        
        Next, you might want to set credentials for the camera:
        
            user = 'me'
            password = 'youllneverguess'
            cam.set_credentials(user, password)
        
        ## Support
        Currently, only `Foscam` and `Wansview` cameras are supported.
        - Foscam C1
        - Wansview K2
        - Wansview Q3S (X Series)
        
        ## API
        - `createCam(brand:str, ip:str, port:int=None) -> (HttpCam, int)`<br>
        creates a HttpCam instance for the supplied `brand`, `ip` address, and `port`.
        If `port` is omitted, the camera brand's default port will be used.
        
        returns the camera instance and the port used as a tuple
        
        
        ### Device Properties
        - `brand()`<br>
        returns the camera instance's brand
        
        - `model()`<br>
        returns the camera instance's model
        Note: for `Wansview` cameras this call returns `'unknown'`
        
        - `host()`<br>
        returns the camera instance's ip address
        
        - `port()`<br>
        returns the camera instance's port
        
        ### Device Configuration
        - `set_credentials(user='', password='')`<br>
        sets the credentials used to access the camera. 
        
        - `set_sensitivities(motion=0, audio=0)`<br>
        
        Sets the sensitivities for motion detection and audio detection. Both take values between 0 (off) and 100 (sensitive).
        
        - `async_reboot(self) -> Response`<br>
        reboots the camera. 
        
        - `async_set_system_time(self) -> Response`<br>
        sets the current local time on the camera. This is used for overlays in the snapshots and feeds.
        
        - `async_set_irled(self, status: Status) -> Response`<br>
        sets the status of the active infrared light on the camera. Valid settings are `Status.ON', `Status.OFF`, and `Status.AUTO`
        
        - `async_set_night_mode(self, status: Status) -> Response`<br>
        sets the status of the passive infrered sensor. Valid settings are `Status.ON', `Status.OFF`, and `Status.AUTO`
        
        - `async_set_ftp_config(self, server, port, user, passwd) -> Response`<br>
        configures the ftp client to allow snapshots and recordings to be stored on a server via FTP.
        
        - `async_set_audio_volumes(self, audio_in=50, audio_out=50) -> Response`<br>
        configures audio volumes for the camera:
        - audio_in: microphone volume
        - audio_out: speaker and alert volume
        
        ### Device Queries
        - `async_get_model(self) -> str`<br>
        queries and returns the brand's model number as a string
        
        - `async_get_night_mode(self) -> IRmode`<br>
        queries and returns the sensor night mode setting:
            - bool result.LED
            - bool result.Sensor
        
        - `async_get_alarm_trigger(self) -> Trigger`<br>
        queries and returns the alarm trigger setting:
            - bool result.motion
            - bool result.audio
        
        - `async_get_alarm_action(self) -> Action`<br>   
        queries and returns the alarm action setting:
            - bool result.audio    - sound the siren
            - bool result.ftp_snap - store snapshots to FTP server
            - bool result.ftp_rec  - store recordings to FTP server
        
        - `async_get_alarm_triggered(self) -> bool`<br>
        queries and returns `True` if an alram was detected.<br>
        *Currently not implemented, returns `False`*
        
        - `async_get_ftp_config(self)`<br>
        queries and returns the current FTP configuration
        
        
        ### Device Actions
        - `async_snap_picture(self)`<br>
        snaps a picture and returns the byte array
        
        - `async_mjpeg_stream(self, request)`<br>
        requests and returns a motion JPEG stream
        
        - `async_set_alarm(self, trigger: Trigger, action: Action) -> Response`<br>
        Arms or disarms the camera by7 setting the `trigger` and `action` settings 
        
        - `async_ptz_preset(self, preset_pos:int)`<br>
        moves the camera to the specified preprogrammed position if PTX is available
        
Keywords: http camera foscam wansview
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
