Add a patch/unpatch example for the Python API

python/examples/Makefile.mk

@@ -2,6 +2,7 @@
 dist_noinst_SCRIPTS += \
     python/examples/ola_artnet_params.py \
     python/examples/ola_devices.py \
+    python/examples/ola_patch_unpatch.py \
     python/examples/ola_plugin_info.py \
     python/examples/ola_rdm_discover.py \
     python/examples/ola_rdm_get.py \

python/examples/ola_patch_unpatch.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Library General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+# ola_patch_unpatch.py
+# Copyright (C) 2015 Simon Marchi
+
+"""Patch and unpatch ports."""
+
+from __future__ import print_function
+from ola.ClientWrapper import ClientWrapper
+from ola.OlaClient import OlaClient
+import argparse
+
+__author__ = 'simon.marchi@polymtl.ca (Simon Marchi)'
+
+
+def ParseArgs():
+  description = 'Patch or unpatch an OLA port.'
+  argparser = argparse.ArgumentParser(description=description)
+  argparser.add_argument('--device', '-d',
+                         metavar='DEV',
+                         type=int,
+                         required=True)
+  argparser.add_argument('--port', '-p',
+                         metavar='PORT',
+                         type=int,
+                         required=True)
+  argparser.add_argument('--universe', '-u',
+                         metavar='UNI',
+                         type=int,
+                         required=True)
+  argparser.add_argument('--mode', '-m',
+                         choices=['input', 'output'],
+                         required=True)
+  argparser.add_argument('--action', '-a',
+                         choices=['patch', 'unpatch'],
+                         required=True)
+
+  return argparser.parse_args()
+
+
+def PatchPortCallback(status):
+  if status.Succeeded():
+    print('Success!')
+  else:
+    print('Oops: {}'.format(status.message))
+  wrapper.Stop()
+
+args = ParseArgs()
+
+device = args.device
+port = args.port
+is_output = args.mode == 'output'
+action = OlaClient.PATCH if args.action == 'patch' else OlaClient.UNPATCH
+universe = args.universe
+
+wrapper = ClientWrapper()
+client = wrapper.Client()
+client.PatchPort(device, port, is_output, action, universe, PatchPortCallback)
+wrapper.Run()

python/ola/OlaClient.py

@@ -726,7 +726,7 @@ def PatchPort(self, device_alias, port, is_output, action, universe,
       device_alias: the alias of the device of which to patch a port
       port: the id of the port
       is_output: select the input or output port
-      action: OlaClient.PATCH or OlcClient.UNPATCH
+      action: OlaClient.PATCH or OlaClient.UNPATCH
       universe: the universe to set the name of
       callback: The function to call once complete, takes one argument, a
         RequestStatus object.