Metadata-Version: 2.1
Name: vvxme
Version: 1.0.0.post2
Summary: Manages your Poly VVX powered by RESTAPIs based on (UCS>=6.1), with CLI Menu or simply use the available VVX class to develope your own applications.
Home-page: https://github.com/eupubs/vvxme.git
Author: Eu Boon Lee
Author-email: boonlee.eu@poly.com
License: MIT
Description: # vvxme
        version: 1.0.0
        
        Manages your Poly VVX powered by RESTAPIs based on (UCS>=6.1), with CLI Menu or simply use the available VVX class to develope your own applications.
        
        Prerequisite:
          - Install python 3.7 or above
          - Install the project:  'pip install vvxme'
          - Full features tested on VVX (non-touch models) running UCS 6.1. Earlier version will exibit some API errors.
        
        OS security notes:  
          - For Windows users: Run the console in Administrator mode to use VVX class in interactive mode.  
          - For Mac users: Requires sudo mode to run CLI Menu - 'sudo python -m vvxme'  
        
        ## Using the inbuilt CLI Menu
        To invoke the CLI Menu, simply open a console and type command: 'python -m vvxme' 
        
        ### Available menus in this version:
        Main Selection Menu:
          1. Show Device Information Menu *__(Useful information of your VVX using standard RestAPI queries)__*
              - Show Device Info
              - Show Device Stats
              - Show Network Info
              - Show Network Stats
              - Show Line Info
              - Show Session Stats
          2. Quick Configuration Menu *__(Quick fix to enabled/disable specific features on your VVX)__*
              - Acoustic Fence Menu
              - Headset Configuration Menu
              - Message Waiting Indicator (LED)
              - Network Discovery - CDP
              - Network Discovery - LLDP
              - Remote Packet Capture
              - Screen Capture
              - SIP Autoanswer
              - SIP Debug & Logging
          3. Web Call Controls Menu *__(Remote dial-out using either TEL/SIP dialstrings from specified Line with specified duation)__*
              - Call Dial 
          4. Simulate Key Events Menu *__(Drive the VVX using your keyboard)__*
              - Simulate Keys 
          
        
        ## Using the VVX Class 
        
        Example:  
        \# python  
        \>>> import vvxme  
        \>>> dev = vvxme.vvx( '192.168.1.10', ('Polycom', '789') )  
        
            Class for VVX based on UCS 6.1.0 REST APIs.
            INPUTS for instance creation:
                - ipaddr = IP address of phone
                - auth = username and password in tuple
            Attributes:
                .ipaddr
                .auth_credentials
                .use_https
                .verify_secure
                .model
                .firmware
                .macaddress
                .baseprofile
            
            Methods:
               .getDeviceInfoV2() - calls "/api/v2/mgmt/device/info"
               .getNetwork() - calls "/api/v1/mgmt/network/info"
               .getLineInfoV2() - calls "/api/v2/mgmt/lineInfo"
               .getCallStatusV2() - calls "/api/v2/webCallControl/callStatus"
               .getRunningConfig() - calls "/api/v1/mgmt/device/runningConfig"
               .getDeviceStats() - calls "/api/v1/mgmt/device/stats"
               .getNetworkStats() - calls "/api/v1/mgmt/network/stats"
               .getSessionStats() - calls "/api/v1/mgmt/media/sessionStats"
               .callDial() - "/api/v1/callctrl/dial"
               .callEnd() - "/api/v1/callctrl/endCall"
               .getConfig() - calls "/api/v1/mgmt/config/get"
               .setConfig() - calls "/api/v1/mgmt/config/set"
        
        
Keywords: poly polycom vvx
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.7
Description-Content-Type: text/markdown
