pyccp 0.10.0__tar.gz

pyccp-0.10.0/.github/workflows/ci.yml

@@ -0,0 +1,89 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_call:
+  schedule:
+    - cron: "0 0 * * 3"
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: "3.15"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v10.3.0
+        with:
+          enable-cache: true
+
+      - name: Install Hatch
+        run: uv tool install hatch
+
+      - name: Run linting
+        run: hatch check code
+
+  format:
+    name: Format
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: "3.15"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v10.3.0
+        with:
+          enable-cache: true
+
+      - name: Install Hatch
+        run: uv tool install hatch
+
+      - name: Run formatting check
+        run: hatch check fmt
+
+  test:
+    name: Test - Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ "3.11", "3.12", "3.13", "3.14", "3.15" ]
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v10.3.0
+        with:
+          enable-cache: true
+
+      - name: Install Hatch
+        run: uv tool install hatch --with hatch-pip-compile
+
+      - name: Run tests
+        run: hatch test -py=${{ matrix.python-version }}

pyccp-0.10.0/.github/workflows/publish.yml

@@ -0,0 +1,42 @@
+name: Publish
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  ci:
+    uses: ./.github/workflows/ci.yml
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: ci
+    environment:
+        name: pypi
+        url: https://pypi.org/project/pyccp/
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: "3.15"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v10.3.3
+        with:
+          enable-cache: true
+
+      - name: Install Hatch
+        run: uv tool install hatch
+
+      - name: Build package
+        run: hatch build
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pyccp-0.10.0/.github/workflows/test_publish.yml

@@ -0,0 +1,42 @@
+name: "Test Publish"
+
+on: workflow_dispatch
+
+jobs:
+  ci:
+    uses: ./.github/workflows/ci.yml
+
+  publish:
+    name: Publish to TestPyPI
+    runs-on: ubuntu-latest
+    needs: ci
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/project/pyccp/
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: "3.15"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v10.3.3
+        with:
+          enable-cache: true
+
+      - name: Install Hatch
+        run: uv tool install hatch
+
+      - name: Build package
+        run: hatch build
+
+      - name: Publish package to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/

pyccp-0.10.0/.gitignore

@@ -0,0 +1,32 @@
+# IDEA
+/.idea/
+
+# Python
+/.venv/
+__pycache__/
+*.py[cod]
+*$py.class
+requirements.*
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST

pyccp-0.10.0/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vladimir Petrigo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyccp-0.10.0/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.5
+Name: pyccp
+Version: 0.10.0
+Summary: CAN Calibration Protocol for Python
+Author-email: Vladimir Petrigo <vladimir.petrigo@gmail.com>
+License-File: LICENSE.md
+Keywords: asam,automotive,ccp,ecu
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development
+Requires-Python: >=3.11
+Requires-Dist: python-can<5,>=4
+Description-Content-Type: text/markdown
+
+[![CI](https://github.com/vpetrigo/pyccp/actions/workflows/ci.yml/badge.svg)](https://github.com/vpetrigo/pyccp/actions/workflows/ci.yml)
+[![PyPI - Version](https://img.shields.io/pypi/v/pyccp)](https://pypi.org/project/pyccp)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyccp)
+[![PyPI Downloads](https://static.pepy.tech/personalized-badge/pyccp?period=monthly&units=INTERNATIONAL_SYSTEM&left_color=GREY&right_color=GREEN&left_text=downloads%2Fmonth)](https://pepy.tech/projects/pyccp)
+
+# CAN Calibration Protocol for Python
+
+Python implementation of the CAN Calibration Protocol (CCP) v2.1 Master, built
+on [python-can](https://python-can.readthedocs.io/). Inspired by [pySART/pyccp](https://github.com/pySART/pyccp).
+
+## Install
+
+```toml
+dependencies = [
+    "pyccp==0.10.0"
+]
+```
+
+## Quick Start
+
+```python
+import can
+from pyccp import Master
+from pyccp.ccp import ReturnCodes
+
+bus = can.Bus(interface="socketcan", channel="can0")
+
+with Master(bus, cro=0x7E1, dto=0x815) as master:
+    resp = master.connect(address=0x39)
+    assert resp is not None and resp.code == ReturnCodes.ACKNOWLEDGE
+
+    resp = master.set_mta(address=0x1000)
+    assert resp is not None and resp.code == ReturnCodes.ACKNOWLEDGE
+
+    resp = master.clear_memory(block_size=0x200)
+    chunks = [b"abcdef", b"ghi", b""]
+
+    for chunk in chunks:
+        resp = master.program6(chunk)
+        assert resp is not None and resp.code == ReturnCodes.ACKNOWLEDGE
+```
+
+## DAQ & Events
+
+```python
+from pyccp import Master, DAQMessage, CommandResponse
+
+with Master(bus, cro=0x7E1, dto=0x815) as master:
+    # Register a callback for DAQ messages
+    master.on_daq(0x816, lambda msg: print(f"DAQ: {msg.daq_id:#04X}, ODT: {msg.pid}, data: {msg.data.hex()}"))
+    # Connect and configure DAQ list
+```
+
+## Logging
+
+```python
+import logging
+
+logging.getLogger("pyccp").setLevel(logging.DEBUG)
+```
+
+## Tests
+
+```sh
+hatch test -py 3.15
+```

pyccp-0.10.0/README.md

@@ -0,0 +1,66 @@
+[![CI](https://github.com/vpetrigo/pyccp/actions/workflows/ci.yml/badge.svg)](https://github.com/vpetrigo/pyccp/actions/workflows/ci.yml)
+[![PyPI - Version](https://img.shields.io/pypi/v/pyccp)](https://pypi.org/project/pyccp)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyccp)
+[![PyPI Downloads](https://static.pepy.tech/personalized-badge/pyccp?period=monthly&units=INTERNATIONAL_SYSTEM&left_color=GREY&right_color=GREEN&left_text=downloads%2Fmonth)](https://pepy.tech/projects/pyccp)
+
+# CAN Calibration Protocol for Python
+
+Python implementation of the CAN Calibration Protocol (CCP) v2.1 Master, built
+on [python-can](https://python-can.readthedocs.io/). Inspired by [pySART/pyccp](https://github.com/pySART/pyccp).
+
+## Install
+
+```toml
+dependencies = [
+    "pyccp==0.10.0"
+]
+```
+
+## Quick Start
+
+```python
+import can
+from pyccp import Master
+from pyccp.ccp import ReturnCodes
+
+bus = can.Bus(interface="socketcan", channel="can0")
+
+with Master(bus, cro=0x7E1, dto=0x815) as master:
+    resp = master.connect(address=0x39)
+    assert resp is not None and resp.code == ReturnCodes.ACKNOWLEDGE
+
+    resp = master.set_mta(address=0x1000)
+    assert resp is not None and resp.code == ReturnCodes.ACKNOWLEDGE
+
+    resp = master.clear_memory(block_size=0x200)
+    chunks = [b"abcdef", b"ghi", b""]
+
+    for chunk in chunks:
+        resp = master.program6(chunk)
+        assert resp is not None and resp.code == ReturnCodes.ACKNOWLEDGE
+```
+
+## DAQ & Events
+
+```python
+from pyccp import Master, DAQMessage, CommandResponse
+
+with Master(bus, cro=0x7E1, dto=0x815) as master:
+    # Register a callback for DAQ messages
+    master.on_daq(0x816, lambda msg: print(f"DAQ: {msg.daq_id:#04X}, ODT: {msg.pid}, data: {msg.data.hex()}"))
+    # Connect and configure DAQ list
+```
+
+## Logging
+
+```python
+import logging
+
+logging.getLogger("pyccp").setLevel(logging.DEBUG)
+```
+
+## Tests
+
+```sh
+hatch test -py 3.15
+```

pyccp-0.10.0/pyproject.toml

@@ -0,0 +1,93 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pyccp"
+version = "0.10.0"
+description = "CAN Calibration Protocol for Python"
+authors = [{ name = "Vladimir Petrigo", email = "vladimir.petrigo@gmail.com" }]
+license-files = ["LICENSE.md"]
+readme = "README.md"
+requires-python = ">=3.11"
+keywords = ["automotive", "ecu", "ccp", "asam"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development",
+    "Topic :: Scientific/Engineering",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+]
+dependencies = [
+    "python-can >=4,<5"
+]
+
+[tool.hatch.envs.hatch-test]
+default-args = ["tests"]
+
+[[tool.hatch.envs.hatch-test.matrix]]
+python = ["3.11", "3.12", "3.13", "3.14", "3.15"]
+
+[tool.ruff.lint]
+select = ["E", "F"]
+
+[tool.ruff]
+line-length = 88
+
+[tool.hatch.env]
+requires = [
+    "hatch-pip-compile",
+]
+
+[tool.hatch.envs.default]
+type = "pip-compile"
+installer = "uv"
+pip-compile-hashes = true
+pip-compile-resolver = "uv"
+pip-compile-installer = "uv"
+path = ".venv"
+
+[tool.hatch.envs.type-check]
+dependencies = [
+    "mypy>=1.0"
+]
+type = "pip-compile"
+installer = "uv"
+pip-compile-hashes = true
+pip-compile-resolver = "uv"
+pip-compile-installer = "uv"
+path = ".venv"
+lock-filename = "requirements.type.txt"
+
+[tool.hatch.envs.type-check.scripts]
+check = "mypy src/"
+
+[tool.setuptools.packages.find]
+where = ["src/pyccp"]
+
+[tool.hatch.build.targets.sdist]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pyccp"]
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.mypy]
+python_version = "3.11"
+warn_return_any = false
+warn_unused_configs = true
+disallow_untyped_defs = false
+
+# Ignore missing type stubs for third-party libraries
+# [[tool.mypy.overrides]]
+# module = [
+#     "pyccp.*",
+#     "wrapt",
+# ]
+# ignore_missing_imports = true

pyccp-0.10.0/src/pyccp/__init__.py

@@ -0,0 +1,5 @@
+"""CAN Calibration Protocol tools; applications configure logging handlers."""
+
+import logging
+
+logging.getLogger(__name__).addHandler(logging.NullHandler())

pyccp-0.10.0/src/pyccp/ccp.py

@@ -0,0 +1,116 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import dataclasses
+import enum
+
+MAX_CRO = 0x0008
+MAX_DTO = 0x0008
+
+CCP_VERSION = (2, 1)
+
+
+@dataclasses.dataclass(frozen=True)
+class Command:
+    """
+    Immutable command configuration.
+
+    Represents a command by its numeric code and the timeout value associated
+    with executing or handling that command. Instances are frozen by the data class
+    declaration, so the recorded values are intended to remain stable after
+    creation.
+
+    :ivar code: Numeric identifier for the command.
+    :ivar timeout: Timeout value associated with the command in milliseconds.
+    """
+
+    code: int
+    timeout: int
+
+
+# Mandatory Commands
+CONNECT = Command(0x01, 25)
+GET_CCP_VERSION = Command(0x1B, 25)
+EXCHANGE_ID = Command(0x17, 25)
+SET_MTA = Command(0x02, 25)
+DNLOAD = Command(0x03, 25)
+UPLOAD = Command(0x04, 25)
+GET_DAQ_SIZE = Command(0x14, 25)
+SET_DAQ_PTR = Command(0x15, 25)
+WRITE_DAQ = Command(0x16, 25)
+START_STOP = Command(0x06, 25)
+DISCONNECT = Command(0x07, 25)
+# Optional Commands
+GET_SEED = Command(0x12, 25)
+UNLOCK = Command(0x13, 25)
+DNLOAD_6 = Command(0x23, 25)
+SHORT_UP = Command(0x0F, 25)
+SELECT_CAL_PAGE = Command(0x11, 25)
+SET_S_STATUS = Command(0x0C, 25)
+GET_S_STATUS = Command(0x0D, 25)
+BUILD_CHKSUM = Command(0x0E, 30000)
+CLEAR_MEMORY = Command(0x10, 30000)
+PROGRAM = Command(0x18, 100)
+PROGRAM_6 = Command(0x22, 100)
+MOVE = Command(0x19, 30000)
+TEST = Command(0x05, 25)
+GET_ACTIVE_CAL_PAGE = Command(0x09, 25)
+START_STOP_ALL = Command(0x08, 25)
+DIAG_SERVICE = Command(0x20, 500)
+ACTION_SERVICE = Command(0x21, 5000)
+
+
+class ReturnCodes(enum.IntEnum):
+    ACKNOWLEDGE = 0x00
+    DAQ_PROCESSOR_OVERLOAD = 0x01  # C0
+    COMMAND_PROCESSOR_BUSY = 0x10  # C1 NONE (wait until ACK or timeout)
+    DAQ_PROCESSOR_BUSY = 0x11  # C1 NONE (wait until ACK or timeout)
+    INTERNAL_TIMEOUT = 0x12  # C1 NONE (wait until ACK or timeout)
+    KEY_REQUEST = 0x18  # C1 NONE (embedded seed&key)
+    SESSION_STATUS_REQUEST = 0x19  # C1 NONE (embedded SET_S_STATUS)
+    COLD_START_REQUEST = 0x20  # C2 COLD START
+    CAL_DATA_INIT_REQUEST = 0x21  # C2 cal. data initialization
+    DAQ_LIST_INIT_REQUEST = 0x22  # C2 DAQ list initialization
+    CODE_UPDATE_REQUEST = 0x23  # C2 (COLD START)
+    UNKNOWN_COMMAND = 0x30  # C3 (FAULT)
+    COMMAND_SYNTAX = 0x31  # C3 FAULT
+    PARAMETER_OUT_OF_RANGE = 0x32  # C3 FAULT
+    ACCESS_DENIED = 0x33  # C3 FAULT
+    OVERLOAD = 0x34  # C3 FAULT
+    ACCESS_LOCKED = 0x35  # C3 FAULT
+    RESOURCE_FUNCTION_NOT_AVAILABLE = 0x36  # C3 FAULT
+
+
+class DisconnectType(enum.IntEnum):
+    TEMPORARY = 0x00
+    PERMANENT = 0x01
+
+
+class SecondaryResource(enum.IntEnum):
+    """
+    Enumeration for secondary resource types.
+
+    This enumeration defines constants representing different types of secondary
+    resources that can be used or required in various systems or operations.
+
+    :cvar CAL: Represents the calibration resource.
+    :cvar DAQ: Represents the data acquisition resource.
+    :cvar PGM: Represents the programming resource.
+    """
+
+    CAL = 1 << 0
+    DAQ = 1 << 1
+    PGM = 1 << 6
+
+
+class DTO:
+    class Type(enum.IntEnum):
+        COMMAND_RETURN_MESSAGE = 255
+        EVENT_MESSAGE = 254
+
+
+def verify_ctr(ctr: int, response: bytes) -> bool:
+    if len(response) < 3:
+        return False
+
+    return ctr == response[2]