Metadata-Version: 2.1
Name: pypon
Version: 0.0.0.8
Summary: White box PON OLT software
Home-page: https://github.com/shadansari
Author: Shad Ansari
Author-email: shad69@gmail.com
License: Apache License 2.0
Description: # pypon
        
        pypon - A simple controller for  PON Optical Line Terminals (OLTs) that support the VOLTHA project's Openolt api.
        
        ## Install pypon in a Python virtual environment
        ```
        $ virtualenv myenv
        .. some output ..
        
        $ source myenv/bin/activate
        (myenv) $ pip install pypon
        ```
        ## Check ponctl is installed
        ```
        $ which ponctl
        ...myenv/bin/ponctl
        ```
        ## ponctl help
        ```
        $ ponctl --help
        Usage: ponctl [OPTIONS] COMMAND [ARGS]...
        
          ponctl - Command-line utility for managing PON whiteboxes
        
          Options:
            --help  Show this message and exit.
        
            Commands:
              devinfo  Get device info from OLT_HOST_PORT.
                ind      Get device info from OLT and, optionally, send them to Kafka...
        ```
        ### Use ponctl to display OLT device info
        ```
        $ ponctl devinfo 10.90.0.114:9191
        vendor: "EdgeCore"
        model: "asfvolt16"
        firmware_version: "BAL.2.6.0__Openolt.2018.10.04"
        ...
        ```
        ### Use ponctl to display streaming indications from OLT
        ```
        $ ponster ind 10.90.0.114:9191
        2019-06-10 15:03.07 Southbound Grpc Rx
        2019-06-10 15:03.07 Indications initialized
        2019-06-10 15:03.07 openolt grpc starting
        2019-06-10 15:03.07 openolt grpc started
        waiting for indication...
        olt_ind {
          oper_state: "up"
          }
          waiting for indication...
        ...
        ```
        If running a local kafka broker, check indications on kafka bus:
        ```
        confluent-kafka/consumer.py localhost:9092 foo openolt.ind-10.90.0.114
        ```
        ## Develop
        ```
        git clone git@github.com:shadansari/openolt.git
        cd pypon
        pipenv shell
        pipenv install
        ```
        Rebuild protobufs if changed:
        ```
        make protos
        ```
        
Keywords: openolt pon whitebox
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Topic :: System :: Networking
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: Apache Software License
Description-Content-Type: text/markdown
