module_copy_jn51xx.py
Go to the documentation of this file.
"""
mbed SDK
Copyright (c) 2011-2015 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.
Author: Przemyslaw Wirkus <Przemyslaw.Wirkus@arm.com>
"""
import os
from .host_test_plugins import HostTestPluginBase
class HostTestPluginCopyMethod_JN51xx(HostTestPluginBase):
# Plugin interface
name = 'HostTestPluginCopyMethod_JN51xx'
type = 'CopyMethod'
capabilities = ['jn51xx']
required_parameters = ['image_path', 'serial']
def __init__(self):
""" ctor
"""
HostTestPluginBase.__init__(self)
def is_os_supported(self, os_name=None):
"""! In this implementation this plugin only is supporeted under Windows machines
"""
# If no OS name provided use host OS name
if not os_name:
os_name = self.mbed_os_supportmbed_os_support()
# This plugin only works on Windows
if os_name and os_name.startswith('Windows'):
return True
return False
def setup(self, *args, **kwargs):
"""! Configure plugin, this function should be called before plugin execute() method is used.
"""
self.JN51XX_PROGRAMMERJN51XX_PROGRAMMER = 'JN51xxProgrammer.exe'
return True
def execute(self, capability, *args, **kwargs):
"""! Executes capability by name
@param capability Capability name
@param args Additional arguments
@param kwargs Additional arguments
@details Each capability e.g. may directly just call some command line program or execute building pythonic function
@return Capability call return value
"""
if not kwargs['image_path']:
self.print_plugin_errorprint_plugin_error("Error: image path not specified")
return False
if not kwargs['serial']:
self.print_plugin_errorprint_plugin_error("Error: serial port not set (not opened?)")
return False
result = False
if self.check_parameterscheck_parameters(capability, *args, **kwargs):
if kwargs['image_path'] and kwargs['serial']:
image_path = os.path.normpath(kwargs['image_path'])
serial_port = kwargs['serial']
if capability == 'jn51xx':
# Example:
# JN51xxProgrammer.exe -s COM15 -f <file> -V0
cmd = [self.JN51XX_PROGRAMMERJN51XX_PROGRAMMER,
'-s', serial_port,
'-f', image_path,
'-V0'
]
result = self.run_commandrun_command(cmd)
return result
def load_plugin():
""" Returns plugin available in this module
"""
return HostTestPluginCopyMethod_JN51xx()
mbed_host_tests.host_tests_plugins.host_test_plugins.HostTestPluginBase
Base class for all plugins used with host tests.
Definition: host_test_plugins.py:32
mbed_host_tests.host_tests_plugins.host_test_plugins.HostTestPluginBase.run_command
def run_command(self, cmd, shell=True)
Runs command from command line.
Definition: host_test_plugins.py:227
mbed_host_tests.host_tests_plugins.host_test_plugins.HostTestPluginBase.print_plugin_error
def print_plugin_error(self, text)
Interface helper methods - overload only if you need to have custom behaviour.
Definition: host_test_plugins.py:93
mbed_host_tests.host_tests_plugins.host_test_plugins.HostTestPluginBase.mbed_os_support
def mbed_os_support(self)
Function used to determine host OS.
Definition: host_test_plugins.py:257
mbed_host_tests.host_tests_plugins.host_test_plugins.HostTestPluginBase.check_parameters
def check_parameters(self, capability, *args, **kwargs)
This function should be ran each time we call execute() to check if none of the required parameters i...
Definition: host_test_plugins.py:211
mbed_host_tests.host_tests_plugins.module_copy_jn51xx.HostTestPluginCopyMethod_JN51xx
Definition: module_copy_jn51xx.py:24
mbed_host_tests.host_tests_plugins.module_copy_jn51xx.HostTestPluginCopyMethod_JN51xx.is_os_supported
def is_os_supported(self, os_name=None)
In this implementation this plugin only is supporeted under Windows machines.
Definition: module_copy_jn51xx.py:37
mbed_host_tests.host_tests_plugins.module_copy_jn51xx.HostTestPluginCopyMethod_JN51xx.setup
def setup(self, *args, **kwargs)
Configure plugin, this function should be called before plugin execute() method is used.
Definition: module_copy_jn51xx.py:49
mbed_host_tests.host_tests_plugins.module_copy_jn51xx.HostTestPluginCopyMethod_JN51xx.execute
def execute(self, capability, *args, **kwargs)
Executes capability by name.
Definition: module_copy_jn51xx.py:55
mbed_host_tests.host_tests_plugins.module_copy_jn51xx.HostTestPluginCopyMethod_JN51xx.JN51XX_PROGRAMMER
JN51XX_PROGRAMMER
Definition: module_copy_jn51xx.py:52
mbed_host_tests.host_tests_plugins.module_copy_jn51xx.HostTestPluginCopyMethod_JN51xx.__init__
def __init__(self)
Definition: module_copy_jn51xx.py:32
mbed_host_tests.host_tests_plugins.module_copy_jn51xx.load_plugin
def load_plugin()
Definition: module_copy_jn51xx.py:89