Metadata-Version: 1.2
Name: mbed-flasher
Version: 0.9.2
Summary: mbed-flasher
Home-page: https://github.com/ARMmbed/mbed-flasher
Author: Jussi Vatjus-Anttila
Author-email: Jussi.Vatjus-Anttila@arm.com
Maintainer: Jussi Vatjus-Anttila
Maintainer-email: Jussi.Vatjus-Anttila@arm.com
License: Copyright 2016 ARM Limited

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Download-URL: https://api.github.com/repos/ARMmbed/mbed-flasher/tarball/v0.9.2
Description: # mbed-flasher
        
        ## Description
        
        mbed-flasher is a simple Python-based tool for flashing single or multiple boards.
        It provides a simple Command Line Interface and Python API for flashing.
        
        The purpose is to provide a clean and simple library that is easy to integrate to other tools.
        It can be easily developed further to support flashing in mbed OS and other platforms.
        Developers can also use it as a standalone tool for flashing their development boards.
        
        
        ## Installation
        
        To install the flasher, use:
        
        `python setup.py install`
        
        To install the flasher in development mode:
        
        `python setup.py develop`
        
        To use JLink flashing, additional package needs to be installed from [here](https://www.segger.com/downloads/jlink/#J-LinkSoftwareAndDocumentationPack).
        JLinkExe must be found from PATH for flasher to be able to use it.
        
        To use STLink flashing (windows only), additional package needs to be installed from [here](https://www.st.com/en/development-tools/stsw-link004.html#sw-tools-scroll).
        `ST-LINK_CLI.exe` must be found from PATH for flasher to be able to use it.
        
        ## Usage
        
        This tool has been tested and verified to work with Windows 7 and Ubuntu (14.04 LTS) Linux.
        
        Devices used in verification: NXP K64F, Nucleo F401RE, BBC micro:bit.
        
        See the actual usage documentation [here](doc/usage.md).
        
        ## Help
        
        **Main help**
        
        ```
        /> mbedflash --help
        usage: mbedflash [-h] [-v] [-s] <command> ...
        
        For specific command help, run: mbedflash <command> --help
        
        optional arguments:
          -h, --help     show this help message and exit
          -v, --verbose  Verbose level... repeat up to three times.
          -s, --silent   Silent - only errors will be printed.
        
        command:
          <command>      command help
            list         Prints a list of supported platforms.
            flashers     Prints a list of supported flashers.
            version      Display version information
            flash        Flash given resource
            reset        Reset given resource
            erase        Erase given resource
        
        ```
        
        **Flash help**
        
        ```
        />mbedflash flash --help
        usage: mbedflash flash [-h] [-i INPUT] [--tid TARGET_ID] [-t PLATFORM_NAME]
                               [--no-reset]
                               [method]
        
        positional arguments:
          method                <simple|pyocd|edbg>, used for flashing
        
        optional arguments:
          -h, --help            show this help message and exit
          -i INPUT, --input INPUT
                                Binary input to be flashed.
          --tid TARGET_ID, --target_id TARGET_ID
                                Target to be flashed, ALL will flash all connected
                                devices with given platform-name, also multiple
                                targets can be given. Does not continue flashing
                                next device in case of failures. Short target_id
                                matches boards by prefix
          -t PLATFORM_NAME, --platform_name PLATFORM_NAME
                                Platform of the target device(s)
          --no-reset            Do not reset device before or after flashing
        
        ```
        
        **Erase help**
        
        ```
        c:\>mbedflash erase --help
        usage: mbedflash erase [-h] [--tid TARGET_ID] [method]
        
        positional arguments:
          method                <simple|pyocd|edbg>, used for erase
        
        optional arguments:
          -h, --help            show this help message and exit
          --tid TARGET_ID, --target_id TARGET_ID
                                Target to be erased or ALL, also multiple targets can
                                be given. Short target_id matches boards by prefix
        
        ```
        
        **Reset help**
        
        ```
        c:\>mbedflash reset --help
        usage: mbedflash reset [-h] [--tid TARGET_ID] [method]
        
        positional arguments:
          method                <simple|pyocd|edbg>, used for reset
        
        optional arguments:
          -h, --help            show this help message and exit
          --tid TARGET_ID, --target_id TARGET_ID
                                Target to be reset or ALL, also multiple targets can
                                be given. Short target_id matches boards by prefix
        
        ```
        
        ## Running unit tests
        
        Required pre-installed packages: coverage, mock
        
        ```
        sudo pip install coverage mock
        ```
        
        Execute all tests:
        ```
        coverage run -m unittest discover -s test
        ```
        Execute hardware tests:
        ```
        coverage run -m unittest discover -s test.hardware
        ```
        Execute non-hardware tests:
        ```
        coverage run -m unittest discover -s test.non_hardware
        ```
        
        
        
        Generate a coverage report:
        
        ```
        coverage html
        ```
        
        ## Creating the installer
        
        **For Windows:**
        ```
        python setup.py build
        python setup.py bdist_msi
        ```
        
        **For Linux:**
        ```
        python setup.py build
        //for rpm package
        python setup.py bdist_rpm
        ```
        Read [more on installers](https://docs.python.org/2/distutils/builtdist.html).
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
