feat: expose globals edit (#73)

Co-authored-by: Tom Allpress <[email protected]>

Author: tallpress

README.md

@@ -11,7 +11,7 @@ __* This SDK is currently in beta__
     - [Detail Instructions](#detail-instructions)
   - [Examples](#examples)
     - [Eva](#eva)
-    - [evasdk.eva_http and evasdk.eva_ws](#evasdkevahttp-and-evasdkevaws)
+    - [evasdk.eva_http and evasdk.eva_ws](#evasdkeva_http-and-evasdkeva_ws)
   - [Versioning](#versioning)
   - [Logging](#logging)
   - [Bugs and feature requests](#bugs-and-feature-requests)
@@ -166,11 +166,11 @@ $ pipenv run test
 $ pipenv shell
 $ pipenv run testd tests/<test-name>_test.py
 
-# some test require supplying ip and token via the `--ip` and `--token` arguements:
-$ pipenv run test --ip 172.16.16.2 --token abc-123-def-456
+# some test require testing against a real robot. Therefore you will be required to supply a ip and token via the `--ip` and `--token` arguments as well as pass the --runrobot flag to notify pytest that you wish to run the robot tests:
+$ pipenv run test --runrobot --ip 172.16.16.2 --token abc-123-def-456
 
 # Tests requiring the robot or long amounts of time will not run by default,
-# these require flags to be enabled, a full list of flags is availble with the help flag:
+# these require flags to be enabled, a full list of flags is available with the help flag:
 $ pipenv run test -h
 ```
 

evasdk/Eva.py

@@ -114,6 +114,9 @@ def gpio_get(self, pin, pin_type):
         self.__logger.debug('Eva.gpio_get called')
         return self.__http_client.gpio_get(pin, pin_type)
 
+    def globals_edit(self, keys, values):
+        self.__logger.debug('Eva.globals_edit called')
+        return self.__http_client.globals_edit(keys, values)
 
     # Toolpaths
     def toolpaths_list(self):

evasdk/eva_http_client.py

@@ -176,7 +176,7 @@ def config_update(self, update):
 
     # GPIO
     def gpio_set(self, pin, status):
-        r = self.__globals_editing(keys='outputs.' + pin, values=status)
+        r = self._globals_edit(keys='outputs.' + pin, values=status)
         if r.status_code != 200:
             eva_error('gpio_set error', r)
 
@@ -189,16 +189,21 @@ def gpio_get(self, pin, pin_type):
         return self.data_snapshot_property('global.{}s'.format(pin_type))[pin]
 
 
-    # GPIO helper function
-    def __globals_editing(self, keys, values):
+    def _globals_edit(self, keys, values):
         data = {'changes': []}
         if (isinstance(keys, list) and isinstance(values, list)):
             data['changes'] = [{'key': k, 'value': v} for k, v in zip(keys, values)]
         else:
             data['changes'].append({'key': keys, 'value': values})
         data = json.dumps(data)
-        r = self.api_call_with_auth('POST', 'data/globals', data)
-        return r
+        return self.api_call_with_auth('POST', 'data/globals', data)
+
+
+    def globals_edit(self, keys, values):
+        r = self._globals_edit(keys, values)
+        if r.status_code != 200:
+            eva_error('globals_edit error', r)
+        return r.json()
 
 
     # TOOLPATHS

tests/Eva_api_test.py

@@ -1,11 +1,12 @@
 from evasdk import Eva
+import requests_mock
 
 
 class TestEva_API:
-    def test_user_agent(self, requests_mock):
+    @requests_mock.Mocker(kw='mock')
+    def test_user_agent(self, **kwargs):
         eva = Eva("example.com", "NONE")
-
-        requests_mock.register_uri(
+        kwargs['mock'].register_uri(
             'GET', 'http://example.com/api/versions',
             request_headers={
                 'User-Agent': 'Automata EvaSDK/0.0.dev0 (Python)',

tests/Eva_gpio_test.py

@@ -9,6 +9,7 @@
 
 @pytest.mark.robot_required
 class TestEva_GPIO:
+    # TODO: currently fail on d1 inputs, requires fix
     def test_get(self, eva):
         # For all io variations, if the key is not present an exception
         # will be thrown so no assertions are required
@@ -27,6 +28,15 @@ def test_set(self, locked_eva):
             locked_eva.gpio_set(pin_name, False)
 
 
+    def test_globals_edit(self, locked_eva):
+        # For all io variations, if an error is encountered, an exception
+        # will be thrown so no assertions are required
+        locked_eva.globals_edit('outputs.ee_d0', True)
+        locked_eva.globals_edit('outputs.d3', True)
+        locked_eva.globals_edit(['outputs.ee_d0', 'outputs.d3'], [True, False])
+        locked_eva.globals_edit(['outputs.ee_d0', 'outputs.d3'], [False, True])
+
+
     @pytest.mark.io_loopback_required
     def test_set_get(self, locked_eva):
         digital_states = [True, False]