Merge remote-tracking branch 'origin/next' into get-vin-heartbeat

Author: GenoJAFord

.github/workflows/python-publish.yml

@@ -0,0 +1,31 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

.github/workflows/python-test.yml

@@ -0,0 +1,32 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Test Open XC Pyton
+
+on: [ pull_request ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6.7]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        sudo apt-get install python-bluetooth -qq -y
+        python -m pip install --upgrade pip
+        python -m pip install pytest pyserial==3.1.1 coveralls
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+
+    - name: Test
+      run: |
+        python setup.py test
+

.travis.yml

@@ -1,6 +1,14 @@
 OpenXC Python Library Changelog
 ===============================
 
+v2.1.0
+----------
+* SonarQube integration
+* Fix: Modem configuration for c5 cellar build now properly sets baud rate
+* Fix: Protobuf general improvements
+* Keyboard interupt via <ctrl>c added to openxc-dump and Obd2 Scanner
+* Stitching Feature, large messages are now packaged and sent in smaller chunks from the vi
+
 v2.0.0
 ----------
 * Known Issue: OpenXC python must be used with firmware 8.0.0 or greater.

CHANGELOG.rst

@@ -4,15 +4,15 @@ OpenXC for Python
 
 .. image:: https://github.com/openxc/openxc-python/raw/master/docs/_static/logo.png
 
-:Version: 2.0.0
+:Version: 2.1.0
 :Web: http://openxcplatform.com
 :Download: http://pypi.python.org/pypi/openxc/
 :Documentation: http://python.openxcplatform.com
 :Source: http://github.com/openxc/openxc-python/
 :Keywords: vehicle, openxc, python
 
-.. image:: https://travis-ci.org/openxc/openxc-python.svg?branch=master
-    :target: https://travis-ci.org/openxc/openxc-python
+.. image:: https://github.com/openxc/openxc-python/workflows/Test%20Open%20XC%20Pyton/badge.svg
+    :target: https://github.com/openxc/openxc-python/actions?query=workflow%3A%22Test+Open+XC+Pyton%22
 
 .. image:: https://coveralls.io/repos/openxc/openxc-python/badge.png?branch=master
     :target: https://coveralls.io/r/openxc/openxc-python?branch=master
@@ -30,7 +30,10 @@ In addition to a port of the Android library API, the package also contains a
 number of command-line tools for connecting to the CAN translator and
 manipulating previously recorded vehicle data.
 
+If you are getting the error "ValueError: No backend available" on windows please reinstall your libusb0 driver using https://github.com/openxc/vi-windows-driver if you are in a envirment where you can not use an unsigned driver  please use https://zadig.akeo.ie/
+
 Due to changes in signals.cpp openxc-python Version 2.0.0 must be used with vi-firmware 8.0.0 or greater. 
+Due to changes with large diagnostic responses Version 2.1.0 must be used with vi-firmware 8.1.0 or greater.
 
 To package run "setup.py sdist bdist_wheel"
 to push to pypi run "python -m twine upload dist/\*"
@@ -44,6 +47,6 @@ Version files:
 License
 ========
 
-Copyright (c) 2012-2017 Ford Motor Company
+Copyright (c) 2012-2020 Ford Motor Company
 
 Licensed under the BSD license.

README.rst

@@ -4,7 +4,7 @@ OpenXC for Python
 
 .. image:: https://github.com/openxc/openxc-python/raw/master/docs/_static/logo.png
 
-:Version: 2.0.0
+:Version: 2.1.0
 :Web: http://openxcplatform.com
 :Download: http://pypi.python.org/pypi/openxc/
 :Documentation: http://python.openxcplatform.com

docs/index.rst

@@ -83,15 +83,17 @@ def handle_responses(self):
                 response = self.queue.get(
                         timeout=self.COMMAND_RESPONSE_TIMEOUT_S)
                 if self._response_matches_request(response):
-                    if type(self) == DiagnosticResponseReceiver:
-                        if self._response_is_multiframe(response):
-                            if response['message_id'] in self.diag_dict:
-                                self.diag_dict[response['message_id']].addFrame(response)
+                    if type(self) == DiagnosticResponseReceiver and self._response_is_multiframe(response):
+                            if response['id'] in self.diag_dict:
+                                self.diag_dict[response['id']].addFrame(response)
                             else:
-                                self.diag_dict[response['message_id']] = MultiframeDiagnosticMessage(response)
+                                self.diag_dict[response['id']] = MultiframeDiagnosticMessage(response)
                             if self._return_final(response):
-                                self.responses.append(self.diag_dict[response['message_id']].getResponse())
-                                self.diag_dict.pop(response['message_id'])
+                                save = self.responses.pop()
+                                dentry = self.diag_dict[response['id']].getResponse()  # DO NOT REMOVE This MUST be saved to a local variable to prevent deallocation
+                                self.responses.append(dentry)                          # DO NOT REMOVE This MUST be saved to a local variable to prevent deallocation
+                                self.responses.append(save)
+                                self.diag_dict.pop(response['id'])
                     self.responses.append(response)
                     if self.quit_after_first:
                         self.running = False
@@ -101,20 +103,20 @@ def handle_responses(self):
 
 class MultiframeDiagnosticMessage:
     def __init__(self, response):
-        self.message_id = response['message_id'] - 16
+        self.id = response['id']
         self.mode = response['mode']
         self.bus = response['bus']
         self.pid = response['pid']
         self.payload = '0x' + response['payload'][8:]
 
     def addFrame(self, response):
-        self.payload += response['payload'][8:]
+        self.payload += response['payload'][2:]
 
     def getResponse(self):
         request = {
             'timestamp': 0,
             'bus': self.bus,
-            'id': self.message_id,
+            'id': self.id,
             'mode': self.mode,
             'success': True,
             'pid': self.pid,
@@ -170,8 +172,9 @@ def _response_matches_request(self, response):
         return response.get('mode', None) == self.diagnostic_request['mode']
 
     def _response_is_multiframe(self, response):
-        if 'frame' in response:
-            return True
+        print(response)
+        if 'total_size' in response.keys() and response["total_size"] > 0:
+                return True
         return False
 
     def _return_final(self, response):
@@ -222,12 +225,12 @@ def _send_complex_request(self, request):
         self.write_bytes(self.streamer.serialize_for_stream(request))
 
     @classmethod
-    def _build_diagnostic_request(cls, message_id, mode, bus=None, pid=None,
+    def _build_diagnostic_request(cls, id, mode, bus=None, pid=None,
             frequency=None, payload=None, decoded_type=None):
         request = {
             'command': "diagnostic_request",
             'request': {
-                'id': message_id,
+                'id': id,
                 'mode': mode
             }
         }
@@ -247,19 +250,19 @@ def _build_diagnostic_request(cls, message_id, mode, bus=None, pid=None,
 
         return request
 
-    def delete_diagnostic_request(self, message_id, mode, bus=None, pid=None):
-        request = self._build_diagnostic_request(message_id, mode, bus, pid)
+    def delete_diagnostic_request(self, id, mode, bus=None, pid=None):
+        request = self._build_diagnostic_request(id, mode, bus, pid)
         request['action'] = 'cancel'
         return self._check_command_response_status(request)
 
-    def create_diagnostic_request(self, message_id, mode, bus=None, pid=None,
+    def create_diagnostic_request(self, id, mode, bus=None, pid=None,
             frequency=None, payload=None, wait_for_ack=True,
             wait_for_first_response=False, decoded_type=None):
         """Send a new diagnostic message request to the VI
 
         Required:
 
-        message_id - The message ID (arbitration ID) for the request.
+        id - The message ID (arbitration ID) for the request.
         mode - the diagnostic mode (or service).
 
         Optional:
@@ -287,7 +290,7 @@ def create_diagnostic_request(self, message_id, mode, bus=None, pid=None,
 
         """
 
-        request = self._build_diagnostic_request(message_id, mode, bus, pid,
+        request = self._build_diagnostic_request(id, mode, bus, pid,
                 frequency, payload, decoded_type)
 
         diag_response_receiver = None
@@ -461,15 +464,15 @@ def write_translated(self, name, value, event=None):
         assert bytes_written == len(message)
         return bytes_written
 
-    def write_raw(self, message_id, data, bus=None, frame_format=None):
+    def write_raw(self, id, data, bus=None, frame_format=None):
         """Send a raw write request to the VI.
         """
-        if not isinstance(message_id, numbers.Number):
+        if not isinstance(id, numbers.Number):
             try:
-                message_id = int(message_id, 0)
+                id = int(id, 0)
             except ValueError:
                 raise ValueError("ID must be numerical")
-        data = {'id': message_id, 'data': data}
+        data = {'id': id, 'data': data}
         if bus is not None:
             data['bus'] = bus
         if frame_format is not None:

openxc/controllers/base.py

@@ -3,8 +3,6 @@ class VehicleMessageStreamer(object):
     bytes_received = 0
 
     def receive(self, payload):
-        if not isinstance(payload, bytes):
-            payload = payload.encode("utf-8")
         if len(payload) > 0:
             self.message_buffer += payload
             self.bytes_received += len(payload)