Rename to something consistent and useful

dannystaple · dannystaple · commit 9af0ab30373e · 2025-01-25T23:04:19.000Z
diff --git a/README.md b/README.md
@@ -30,7 +30,7 @@ This has previously been tested on Linux, OSX and Windows. OSX and Windows requi
 
 As a library:
 
-    >>> import usb_arm
+    >>> import owi_maplin_usb_arm as usb_arm
 
 To initialise libusb and the arm
 
diff --git a/demos/bluedot/led_only.py b/demos/bluedot/led_only.py
@@ -1,16 +1,16 @@
 from bluedot import BlueDot
 from signal import pause
-import usb_arm
+import owi_maplin_robot_arm
 
-arm = usb_arm.Arm()
+arm = owi_maplin_robot_arm.Arm()
 
 
 def led_pressed(pos):
-    arm.tell(usb_arm.LedOn)
+    arm.tell(owi_maplin_robot_arm.LedOn)
 
 
 def stop(*args):
-    arm.tell(usb_arm.Stop)
+    arm.tell(owi_maplin_robot_arm.Stop)
 
 
 bd = BlueDot(cols=3, rows=2)
diff --git a/demos/bluedot/simple_grid.py b/demos/bluedot/simple_grid.py
@@ -1,51 +1,51 @@
 from bluedot import BlueDot
 from signal import pause
-import usb_arm
+import owi_maplin_robot_arm
 
-arm = usb_arm.Arm()
+arm = owi_maplin_robot_arm.Arm()
 
 
 def led_pressed(pos):
-    arm.tell(usb_arm.LedOn)
+    arm.tell(owi_maplin_robot_arm.LedOn)
 
 
 def stop(*args):
-    arm.tell(usb_arm.Stop)
+    arm.tell(owi_maplin_robot_arm.Stop)
 
 
 def grip_pressed(pos):
     if pos.top:
-        arm.tell(usb_arm.GripsClose)
+        arm.tell(owi_maplin_robot_arm.GripsClose)
     if pos.bottom:
-        arm.tell(usb_arm.GripsOpen)
+        arm.tell(owi_maplin_robot_arm.GripsOpen)
 
 
 def wrist_pressed(pos):
     if pos.top:
-        arm.tell(usb_arm.WristUp)
+        arm.tell(owi_maplin_robot_arm.WristUp)
     if pos.bottom:
-        arm.tell(usb_arm.WristDown)
+        arm.tell(owi_maplin_robot_arm.WristDown)
 
 
 def elbow_pressed(pos):
     if pos.top:
-        arm.tell(usb_arm.ElbowUp)
+        arm.tell(owi_maplin_robot_arm.ElbowUp)
     if pos.bottom:
-        arm.tell(usb_arm.ElbowDown)
+        arm.tell(owi_maplin_robot_arm.ElbowDown)
 
 
 def shoulder_pressed(pos):
     if pos.top:
-        arm.tell(usb_arm.ShoulderUp)
+        arm.tell(owi_maplin_robot_arm.ShoulderUp)
     if pos.bottom:
-        arm.tell(usb_arm.ShoulderDown)
+        arm.tell(owi_maplin_robot_arm.ShoulderDown)
 
 
 def base_pressed(pos):
     if pos.left:
-        arm.tell(usb_arm.BaseCtrClockWise)
+        arm.tell(owi_maplin_robot_arm.BaseCtrClockWise)
     if pos.right:
-        arm.tell(usb_arm.BaseClockWise)
+        arm.tell(owi_maplin_robot_arm.BaseClockWise)
 
 
 bd = BlueDot(cols=3, rows=2)
diff --git a/demos/key_ctrl.py b/demos/key_ctrl.py
@@ -1,6 +1,6 @@
 """key_ctrl - key based arm controller"""
 from functools import partial
-import usb_arm
+import owi_maplin_robot_arm
 import pygame
 from pygame.locals import *
 import sys
@@ -18,22 +18,22 @@ def make_keymap():
     """Bp - an initialised arm bitpattern.
     returns the keymap"""
     return {
-        K_z: usb_arm.BaseClockWise,
-        K_x: usb_arm.BaseCtrClockWise,
-        K_r: usb_arm.CloseGrips,
-        K_f: usb_arm.OpenGrips,
-        K_a: usb_arm.ShoulderDown,
-        K_q: usb_arm.ShoulderUp,
-        K_s: usb_arm.ElbowDown,
-        K_w: usb_arm.ElbowUp,
-        K_d: usb_arm.WristDown,
-        K_e: usb_arm.WristUp}
+        K_z: owi_maplin_robot_arm.BaseClockWise,
+        K_x: owi_maplin_robot_arm.BaseCtrClockWise,
+        K_r: owi_maplin_robot_arm.CloseGrips,
+        K_f: owi_maplin_robot_arm.OpenGrips,
+        K_a: owi_maplin_robot_arm.ShoulderDown,
+        K_q: owi_maplin_robot_arm.ShoulderUp,
+        K_s: owi_maplin_robot_arm.ElbowDown,
+        K_w: owi_maplin_robot_arm.ElbowUp,
+        K_d: owi_maplin_robot_arm.WristDown,
+        K_e: owi_maplin_robot_arm.WristUp}
 
 
 def key_loop():
     km = make_keymap()
     try:
-        arm = usb_arm.Arm()
+        arm = owi_maplin_robot_arm.Arm()
     except AttributeError:
         print("Please make sure the arm is connected and turned on")
         sys.exit(1)
diff --git a/demos/web_arm/arm_hello.py b/demos/web_arm/arm_hello.py
@@ -1,16 +1,16 @@
-import usb_arm
+import owi_maplin_robot_arm
 from flask import Flask, Response
 
 
-arm = usb_arm.Arm()
+arm = owi_maplin_robot_arm.Arm()
 app = Flask(__name__)
 
 
 @app.route('/')
 def flash():
     def inner():
         yield "starting</br>\n"
-        arm.move(usb_arm.LedOn)
+        arm.move(owi_maplin_robot_arm.LedOn)
         yield "completed\n"
     return Response(inner())
 
diff --git a/demos/web_arm/arm_server.py b/demos/web_arm/arm_server.py
@@ -1,25 +1,25 @@
-import usb_arm
+import owi_maplin_robot_arm
 from flask import Flask, Response, request
 
 
-arm = usb_arm.Arm()
+arm = owi_maplin_robot_arm.Arm()
 app = Flask(__name__)
 
 movemap = {
-    "GripsClose": usb_arm.GripsClose,
-    "CloseGrips": usb_arm.CloseGrips,
-    "GripsOpen": usb_arm.GripsOpen,
-    "OpenGrips": usb_arm.OpenGrips,
-    "Stop": usb_arm.Stop,
-    "WristUp": usb_arm.WristUp,
-    "WristDown": usb_arm.WristDown,
-    "ElbowUp": usb_arm.ElbowUp,
-    "ElbowDown": usb_arm.ElbowDown,
-    "ShoulderUp": usb_arm.ShoulderUp,
-    "ShoulderDown": usb_arm.ShoulderDown,
-    "BaseClockWise": usb_arm.BaseClockWise,
-    "BaseCtrClockWise": usb_arm.BaseCtrClockWise,
-    "LedOn": usb_arm.LedOn
+    "GripsClose": owi_maplin_robot_arm.GripsClose,
+    "CloseGrips": owi_maplin_robot_arm.CloseGrips,
+    "GripsOpen": owi_maplin_robot_arm.GripsOpen,
+    "OpenGrips": owi_maplin_robot_arm.OpenGrips,
+    "Stop": owi_maplin_robot_arm.Stop,
+    "WristUp": owi_maplin_robot_arm.WristUp,
+    "WristDown": owi_maplin_robot_arm.WristDown,
+    "ElbowUp": owi_maplin_robot_arm.ElbowUp,
+    "ElbowDown": owi_maplin_robot_arm.ElbowDown,
+    "ShoulderUp": owi_maplin_robot_arm.ShoulderUp,
+    "ShoulderDown": owi_maplin_robot_arm.ShoulderDown,
+    "BaseClockWise": owi_maplin_robot_arm.BaseClockWise,
+    "BaseCtrClockWise": owi_maplin_robot_arm.BaseCtrClockWise,
+    "LedOn": owi_maplin_robot_arm.LedOn
 }
 
 
diff --git a/demos/web_arm/arm_server2.py b/demos/web_arm/arm_server2.py
@@ -1,25 +1,25 @@
-import usb_arm
+import owi_maplin_robot_arm
 from flask import Flask, Response, request, render_template
 
 
-arm = usb_arm.Arm()
+arm = owi_maplin_robot_arm.Arm()
 app = Flask(__name__)
 
 movemap = {
-    "GripsClose": usb_arm.GripsClose,
-    "CloseGrips": usb_arm.CloseGrips,
-    "GripsOpen": usb_arm.GripsOpen,
-    "OpenGrips": usb_arm.OpenGrips,
-    "Stop": usb_arm.Stop,
-    "WristUp": usb_arm.WristUp,
-    "WristDown": usb_arm.WristDown,
-    "ElbowUp": usb_arm.ElbowUp,
-    "ElbowDown": usb_arm.ElbowDown,
-    "ShoulderUp": usb_arm.ShoulderUp,
-    "ShoulderDown": usb_arm.ShoulderDown,
-    "BaseClockWise": usb_arm.BaseClockWise,
-    "BaseCtrClockWise": usb_arm.BaseCtrClockWise,
-    "LedOn": usb_arm.LedOn
+    "GripsClose": owi_maplin_robot_arm.GripsClose,
+    "CloseGrips": owi_maplin_robot_arm.CloseGrips,
+    "GripsOpen": owi_maplin_robot_arm.GripsOpen,
+    "OpenGrips": owi_maplin_robot_arm.OpenGrips,
+    "Stop": owi_maplin_robot_arm.Stop,
+    "WristUp": owi_maplin_robot_arm.WristUp,
+    "WristDown": owi_maplin_robot_arm.WristDown,
+    "ElbowUp": owi_maplin_robot_arm.ElbowUp,
+    "ElbowDown": owi_maplin_robot_arm.ElbowDown,
+    "ShoulderUp": owi_maplin_robot_arm.ShoulderUp,
+    "ShoulderDown": owi_maplin_robot_arm.ShoulderDown,
+    "BaseClockWise": owi_maplin_robot_arm.BaseClockWise,
+    "BaseCtrClockWise": owi_maplin_robot_arm.BaseCtrClockWise,
+    "LedOn": owi_maplin_robot_arm.LedOn
 }
 
 
diff --git a/owi_maplin_usb_arm/__init__.py b/owi_maplin_usb_arm/__init__.py
diff --git a/setup.py b/setup.py
@@ -1,9 +1,9 @@
 from distutils.core import setup
 
 setup(
-    name='usb_robot_arm',
-    version='0.2.0',
-    packages=['usb_robot_arm',],
+    name='owi_maplin_usb_arm',
+    version='0.4.0',
+    packages=['owi_maplin_usb_arm',],
     author="Danny Staple - Orionrobots",
     license='Creative Commons By Attribution Share-Alike v3.0',
     long_description=open('README.md').read(),
diff --git a/setup_arm.sh b/setup_arm.sh
@@ -1,6 +1,6 @@
 #!/bin/env bash -e
 # Raspbian setup
-apt-get update -y 
+apt-get update -y
 apt-get install -y python3-libusb1 python3-pip git
 pip3 install git+https://github.com/orionrobots/python_usb_robot_arm
 cat <<END >/etc/udev/rules.d/42-usb-arm-permissions.rules
diff --git a/tests/test_usb_arm.py b/tests/test_usb_arm.py
@@ -1,4 +1,4 @@
-import usb_arm
+import owi_maplin_robot_arm
 import unittest
 import time
 
@@ -28,7 +28,7 @@ def reset(self):
         self.ctrl_commands = []
 
 
-class TestableArm(usb_arm.Arm):
+class TestableArm(owi_maplin_robot_arm.Arm):
     def __init__(self):
         self.dev = StubUsb()
 
@@ -48,46 +48,46 @@ def setUp(self):
         self.arm = TestableArm()
 
     def test_move_includes_correct_verb(self):
-        self.arm.move(usb_arm.LedOn)
+        self.arm.move(owi_maplin_robot_arm.LedOn)
         cmd, time = self.arm.get_ctrl_cmd(0)
-        self.assertEqual(usb_arm.LedOn, cmd)
+        self.assertEqual(owi_maplin_robot_arm.LedOn, cmd)
 
     def test_move_adds_stop_verb(self):
-        self.arm.move(usb_arm.ShoulderDown)
-        self.assertEqual([usb_arm.ShoulderDown, usb_arm.Stop], self.arm.get_ctrl_cmd_list())
+        self.arm.move(owi_maplin_robot_arm.ShoulderDown)
+        self.assertEqual([owi_maplin_robot_arm.ShoulderDown, owi_maplin_robot_arm.Stop], self.arm.get_ctrl_cmd_list())
 
     def test_default_move_time_spaces_commands_as_expected(self):
-        self.arm.move(usb_arm.ElbowUp)
+        self.arm.move(owi_maplin_robot_arm.ElbowUp)
         cmd0, time0 = self.arm.get_ctrl_cmd(0)
         cmd1, time1 = self.arm.get_ctrl_cmd(1)
         self.assertIn(time1 - time0, range(990, 1010))
 
     def test_specific_move_time_spaces_commands_as_expected(self):
-        self.arm.move(usb_arm.ElbowUp, 2)
+        self.arm.move(owi_maplin_robot_arm.ElbowUp, 2)
         cmd0, time0 = self.arm.get_ctrl_cmd(0)
         cmd1, time1 = self.arm.get_ctrl_cmd(1)
         self.assertIn(time1 - time0, range(1090, 2010))
 
     def test_untimed_seq_of_commands_orders_as_expected(self):
-        cmds = [[usb_arm.ElbowUp], [usb_arm.ElbowDown], [usb_arm.ShoulderDown]]
+        cmds = [[owi_maplin_robot_arm.ElbowUp], [owi_maplin_robot_arm.ElbowDown], [owi_maplin_robot_arm.ShoulderDown]]
         self.arm.doActions(cmds)
         expected_cmds = []
         for c in cmds:
             expected_cmds.append(c[0])
-            expected_cmds.append(usb_arm.Stop)
+            expected_cmds.append(owi_maplin_robot_arm.Stop)
         self.assertEqual(expected_cmds, self.arm.get_ctrl_cmd_list())
 
     def test_timed_seq_of_commands_orders_as_expected(self):
-        cmds = [[usb_arm.ElbowUp, 1], [usb_arm.ElbowDown, 2], [usb_arm.ShoulderDown, 3]]
+        cmds = [[owi_maplin_robot_arm.ElbowUp, 1], [owi_maplin_robot_arm.ElbowDown, 2], [owi_maplin_robot_arm.ShoulderDown, 3]]
         self.arm.doActions(cmds)
         expected_cmds = []
         for c in cmds:
             expected_cmds.append(c[0])
-            expected_cmds.append(usb_arm.Stop)
+            expected_cmds.append(owi_maplin_robot_arm.Stop)
         self.assertEqual(expected_cmds, self.arm.get_ctrl_cmd_list())
 
     def test_timed_seq_of_commands_has_expected_times(self):
-        cmds = [[usb_arm.BaseCtrClockWise, 2], [usb_arm.ElbowUp, 4]]
+        cmds = [[owi_maplin_robot_arm.BaseCtrClockWise, 2], [owi_maplin_robot_arm.ElbowUp, 4]]
         self.arm.doActions(cmds)
         cmd0, time0 = self.arm.get_ctrl_cmd(0)
         cmd1, time1 = self.arm.get_ctrl_cmd(1)
@@ -98,8 +98,8 @@ def test_timed_seq_of_commands_has_expected_times(self):
         self.assertIn(time3 - time2, range(3090, 4010))
 
     def test_both_grips_action_names_exist(self):
-        self.assertEqual(usb_arm.GripsOpen, usb_arm.OpenGrips)
-        self.assertEqual(usb_arm.GripsClose, usb_arm.CloseGrips)
+        self.assertEqual(owi_maplin_robot_arm.GripsOpen, owi_maplin_robot_arm.OpenGrips)
+        self.assertEqual(owi_maplin_robot_arm.GripsClose, owi_maplin_robot_arm.CloseGrips)
 
 
 if __name__ == '__main__':
