Metadata-Version: 2.1
Name: philip-pal
Version: 0.0.1
Summary: Protocol abstraction and parser for PHiLIP
Home-page: https://github.com/riot-appstore/PHiLIP
Author: Kevin Weiss
Author-email: weiss.kevin604@gmail.com
License: MIT
Description: PHiLIP PAL (PHiLIP Protocol Abstraction Layer)
        ================================
        
        Introduction
        ------------
        
        A set of python modules that abstract away and standardize shell based command for bare metal memory map access.
        
        PHiLIP PAL is used to interface to a memory map specified from a csv or by the device.  It handles the parsing of offsets, sizes, etc. of the device.
        
        To use this interface a memory must be provided, by default the package contains the PHiLIP memory map for all the versions.  If a development version of PHiLIP is used and a memory map has not been released, the memory map can be scanned from the device.
        
        ### PHiLIP PAL Installation
        To interface to PHiLIP first install the philip_pal for python3.
        
        `sudo pip3 install philip_pal`
        
        ### Running PHiLIP PAL
        First connected PHiLIP to the computer so a serial port connection is available.
        
        This script handles interfacing to the PHiLIP device.  It parses data and
        exposes from the PhilipExtIf class to be run in a shell.
        
        The pip installation installs a script that can be run with `philip_shell`
        
        The purpose of this script is allow easy setup and manual usage of PHiLIP.
        
        Usage
        -----
        
        ```
        usage: philip_shell.py  [-h]
                                [--loglevel {debug,info,warning,error,fatal,critical}]
                                [--port PORT]
                                [--filter-data]
        
        optional arguments:
          -h, --help            show this help message and exit
          --loglevel {debug,info,warning,error,fatal,critical}
                                Python logger log level (default: warning)
          --port, -p
                                Specify the serial port
          --data_only, -do
                                Filters data from philip responses to only display
                                what is needed (default: False)
        ```
        
        Upon starting the shell use the `help` command to see what functionality is available.
        
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Requires-Python: >=3.4.*
Description-Content-Type: text/markdown
