Mbed Host Tests
module_reset_ublox.py
Go to the documentation of this file.
1 """
2 mbed SDK
3 Copyright (c) 2011-2015 ARM Limited
4 
5 Licensed under the Apache License, Version 2.0 (the "License");
6 you may not use this file except in compliance with the License.
7 You may obtain a copy of the License at
8 
9  http://www.apache.org/licenses/LICENSE-2.0
10 
11 Unless required by applicable law or agreed to in writing, software
12 distributed under the License is distributed on an "AS IS" BASIS,
13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 See the License for the specific language governing permissions and
15 limitations under the License.
16 
17 Author: Przemyslaw Wirkus <Przemyslaw.Wirkus@arm.com>
18 """
19 
20 from .host_test_plugins import HostTestPluginBase
21 
22 
24 
25  # Plugin interface
26  name = 'HostTestPluginResetMethod_ublox'
27  type = 'ResetMethod'
28  capabilities = ['ublox']
29  required_parameters = []
30  stable = False
31 
32  def is_os_supported(self, os_name=None):
33  """! In this implementation this plugin only is supporeted under Windows machines
34  """
35  # If no OS name provided use host OS name
36  if not os_name:
37  os_name = self.mbed_os_supportmbed_os_support()
38 
39  # This plugin only works on Windows
40  if os_name and os_name.startswith('Windows'):
41  return True
42  return False
43 
44  def setup(self, *args, **kwargs):
45  """! Configure plugin, this function should be called before plugin execute() method is used.
46  """
47  # Note you need to have jlink.exe on your system path!
48  self.JLINKJLINK = 'jlink.exe'
49  return True
50 
51  def execute(self, capability, *args, **kwargs):
52  """! Executes capability by name
53 
54  @param capability Capability name
55  @param args Additional arguments
56  @param kwargs Additional arguments
57 
58  @details Each capability e.g. may directly just call some command line program or execute building pythonic function
59 
60  @return Capability call return value
61  """
62  result = False
63  if self.check_parameterscheck_parameters(capability, *args, **kwargs) is True:
64  if capability == 'ublox':
65  # Example:
66  # JLINK.exe --CommanderScript aCommandFile
67  cmd = [self.JLINKJLINK,
68  '-CommanderScript',
69  r'reset.jlink']
70  result = self.run_commandrun_command(cmd)
71  return result
72 
73 
75  """ Returns plugin available in this module
76  """
def run_command(self, cmd, shell=True)
Runs command from command line.
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...
def is_os_supported(self, os_name=None)
In this implementation this plugin only is supporeted under Windows machines.
def execute(self, capability, *args, **kwargs)
Executes capability by name.
def setup(self, *args, **kwargs)
Configure plugin, this function should be called before plugin execute() method is used.