Merge pull request #12 from bofh69/copilot/create-error-enum-for-sketch

Add ErrorCode enum to replace hardcoded negative return values in Arduino sketch

Author: bofh69

.github/workflows/python-ci.yml

@@ -52,11 +52,8 @@ jobs:
           pip install black ruff
       
       - name: Check with Black
-        run: black --check src/ tests/
+        run: black -l 79 --check src/ tests/
 
-      - name: Check with Ruff format
-        run: ruff format --check src/ tests/
-  
   typecheck:
     name: Type Check with mypy
     runs-on: ubuntu-latest

Makefile

@@ -0,0 +1,75 @@
+# SPDX-FileCopyrightText: 2025 PN5180-tagomatic contributors
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+VENV := venv
+PYTHON := $(VENV)/bin/python
+PIP := $(VENV)/bin/pip
+PYTEST := $(VENV)/bin/pytest
+RUFF := $(VENV)/bin/ruff
+BLACK := $(VENV)/bin/black
+MYPY := $(VENV)/bin/mypy
+
+.PHONY: help
+help:
+	@echo "PN5180-tagomatic development targets:"
+	@echo "  make venv         - Create virtual environment"
+	@echo "  make install      - Install package and dependencies"
+	@echo "  make install-dev  - Install package with dev dependencies"
+	@echo "  make test         - Run tests"
+	@echo "  make lint         - Run linting checks"
+	@echo "  make format       - Format code with black"
+	@echo "  make type-check   - Run type checking with mypy"
+	@echo "  make clean        - Remove virtual environment and build artifacts"
+
+$(VENV)/bin/activate:
+	python3 -m venv $(VENV)
+	$(PIP) install --upgrade pip
+
+.PHONY: venv
+venv: $(VENV)/bin/activate
+
+# Install package with regular dependencies
+$(VENV)/.timestamp: $(VENV)/bin/activate pyproject.toml
+	$(PIP) install -e .
+	touch $@
+
+.PHONY:  install
+install: $(VENV)/.timestamp
+
+# Install package with development dependencies
+$(VENV)/.timestamp-dev: $(VENV)/bin/activate pyproject.toml
+	$(PIP) install -e ".[dev]"
+	touch $@
+
+.PHONY: install-dev
+install-dev: $(VENV)/.timestamp-dev
+
+.PHONY: test
+test: install-dev
+	$(PYTEST)
+
+.PHONY: lint
+lint: install-dev
+	$(RUFF) check src/ tests/
+
+.PHONY: format
+format: install-dev
+	$(BLACK) -l79 src/ tests/
+
+.PHONY: type-check
+type-check: install-dev
+	$(MYPY) src/
+
+.PHONY: clean
+clean:
+	rm -rf $(VENV)
+	rm -rf build/
+	rm -rf dist/
+	rm -rf *.egg-info
+	rm -rf .pytest_cache
+	rm -rf .ruff_cache
+	rm -rf .mypy_cache
+	rm -rf htmlcov/
+	rm -rf .coverage
+	find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true
+	find . -type f -name "*.pyc" -delete

README.md

@@ -5,8 +5,8 @@ SPDX-FileCopyrightText: 2025 PN5180-tagomatic contributors
 SPDX-License-Identifier: GPL-3.0-or-later
 -->
 
-This is a work in progress. Few things described here actually works
-yet.
+**This is a work in progress. Some things described here doesn't work yet,
+and bug reports are not welcome at this time.**
 
 USB based RFID reader with Python interface
 
@@ -102,14 +102,13 @@ pytest
 
 ```bash
 # Linting
-ruff check src/ tests/
+make check
 
 # Formatting
-black src/ tests/
-ruff format src/ tests/
+make format
 
 # Type checking
-mypy src/
+make type-check
 ```
 
 ## License
@@ -129,4 +128,5 @@ Contributions are welcome! Please ensure that:
 
 ## Acknowledgments
 
-This project uses the PN5180 NFC Frontend from NXP Semiconductors.
+This project uses FastLED by Daniel Garcia et al.
+It also uses SimpleRPC by Jeroen F.J. Laros, Chris Flesher et al.

sketch/pn5180_reader/pn5180_reader.ino

@@ -21,6 +21,25 @@
 #include <FastLED.h>
 #include <simpleRPC.h>
 
+// Error codes for negative return values
+enum ErrorCode {
+  ERR_DATA_LEN_TOO_LARGE = -1,
+  ERR_SEND_BUSY_CHECK_FIRST = -2,
+  ERR_SEND_BUSY_CHECK_SECOND = -3,
+  ERR_SEND_BUSY_CHECK_THIRD = -4,
+  ERR_RECV_BUSY_CHECK_FIRST = -5,
+  ERR_RECV_BUSY_CHECK_SECOND = -6,
+  ERR_RECV_BUSY_CHECK_THIRD = -7,
+  ERR_TOO_MANY_ELEMENTS = -8,
+  ERR_TOO_MANY_ADDRESSES = -9,
+  ERR_EEPROM_DATA_TOO_LARGE = -10,
+  ERR_LEN_TOO_LARGE = -11,
+  ERR_TOO_MANY_PARAMS = -12,
+  ERR_SELECT_COMMAND_TOO_LARGE = -13,
+  ERR_TX_DATA_TOO_LARGE = -14,
+  ERR_SEND_DATA_TOO_LARGE = -15
+};
+
 // SPI commands for PN5180:
 static const uint8_t PN5180_WRITE_REGISTER = 0x00;
 static const uint8_t PN5180_WRITE_REGISTER_OR_MASK = 0x01;
@@ -92,13 +111,13 @@ static int send_spi_data(const uint8_t* data, size_t data_len) {
   uint8_t buffer[256];
   if (data_len > sizeof(buffer)) {
     log("data_len too large");
-    return -1;
+    return ERR_DATA_LEN_TOO_LARGE;
   }
   memcpy(buffer, data, data_len);
 
   if (!wait_busy_is(LOW)) {
     log("First busy check failed");
-    return -2;
+    return ERR_SEND_BUSY_CHECK_FIRST;
   }
 
   digitalWrite(PN5180_NSS, LOW);
@@ -110,15 +129,15 @@ static int send_spi_data(const uint8_t* data, size_t data_len) {
   int retval = 0;
   if (!wait_busy_is(HIGH)) {
     log("Second busy check failed");
-    retval = -3;
+    retval = ERR_SEND_BUSY_CHECK_SECOND;
   }
 
   PN_SPI.endTransaction();
   digitalWrite(PN5180_NSS, HIGH);
 
   if (!retval && !wait_busy_is(LOW)) {
     log("Third busy check failed");
-    retval = -4;
+    retval = ERR_SEND_BUSY_CHECK_THIRD;
   }
 
   return retval;
@@ -129,7 +148,7 @@ static int recv_spi_data(uint8_t* buffer, size_t buffer_len) {
 
   if (!wait_busy_is(LOW)) {
     log("First busy check failed");
-    return -1;
+    return ERR_RECV_BUSY_CHECK_FIRST;
   }
 
   digitalWrite(PN5180_NSS, LOW);
@@ -141,15 +160,15 @@ static int recv_spi_data(uint8_t* buffer, size_t buffer_len) {
   int retval = 0;
   if (!wait_busy_is(HIGH)) {
     log("Second busy check failed");
-    retval = -2;
+    retval = ERR_RECV_BUSY_CHECK_SECOND;
   }
 
   PN_SPI.endTransaction();
   digitalWrite(PN5180_NSS, HIGH);
 
   if (!retval && !wait_busy_is(LOW)) {
     log("Third busy check failed");
-    retval = -3;
+    retval = ERR_RECV_BUSY_CHECK_THIRD;
   }
 
   return retval;
@@ -229,7 +248,7 @@ static int write_register_and_mask(uint8_t addr, uint32_t value) {
 static int write_register_multiple(Vector<Object<uint8_t, uint8_t, uint32_t>>& elements) {
   if (elements.size > 42) {
     log("Too many elements");
-    return -1;
+    return ERR_TOO_MANY_ELEMENTS;
   }
 
   uint8_t buffer[211];
@@ -290,7 +309,7 @@ static Object<int, Vector<uint32_t>> read_register_multiple(Vector<uint8_t>& add
 
   if (addrs.size > 18) {
     log("Too many addresses");
-    get<0>(result) = -1;
+    get<0>(result) = ERR_TOO_MANY_ADDRESSES;
     return result;
   }
 
@@ -330,7 +349,7 @@ static int16_t write_eeprom(uint8_t addr, Vector<uint8_t>& values) {
   uint8_t buffer[256];
   if (values.size > 255) {
     log("Too much data to write");
-    return -1;
+    return ERR_EEPROM_DATA_TOO_LARGE;
   }
 
   buffer[0] = PN5180_WRITE_EEPROM;
@@ -385,7 +404,7 @@ static int16_t write_tx_data(Vector<uint8_t>& values) {
   uint8_t buffer[261];
   if (values.size > 260) {
     log("Too much data to write");
-    return -1;
+    return ERR_TX_DATA_TOO_LARGE;
   }
 
   buffer[0] = PN5180_WRITE_TX_DATA;
@@ -413,7 +432,7 @@ static int16_t send_data(uint8_t bits, Vector<uint8_t>& values) {
   uint8_t buffer[262];
   if (values.size > 260) {
     log("Too much data to write");
-    return -1;
+    return ERR_SEND_DATA_TOO_LARGE;
   }
 
   buffer[0] = PN5180_SEND_DATA;
@@ -442,7 +461,7 @@ static Object<int, Vector<uint8_t>> read_data(uint16_t len) {
 
   if (len > sizeof(response)) {
     log("len too large");
-    get<0>(result) = -1;
+    get<0>(result) = ERR_LEN_TOO_LARGE;
     return result;
   }
 
@@ -486,7 +505,7 @@ static int switch_mode(uint8_t mode, Vector<uint8_t>& params) {
   uint8_t buffer[1 + 1 + 4];
   if (params.size > 4) {
     log("Too many params");
-    return -1;
+    return ERR_TOO_MANY_PARAMS;
   }
   buffer[0] = PN5180_SWITCH_MODE;
   buffer[1] = mode;
@@ -553,7 +572,7 @@ static int16_t epc_inventory(Vector<uint8_t>& select_command, uint8_t select_com
                              uint8_t begin_round[3], uint8_t timeslot_behavior) {
   if (select_command.size > 39) {
     log("Too large select_command");
-    return -1;
+    return ERR_SELECT_COMMAND_TOO_LARGE;
   }
 
   uint8_t buffer[47];

src/pn5180_tagomatic/pn5180.py

@@ -201,11 +201,15 @@ def write_register_and_mask(self, addr: int, value: int) -> None:
         """
         self._validate_uint8(addr, "addr")
         self._validate_uint32(value, "value")
-        result = cast(int, self._interface.write_register_and_mask(addr, value))
+        result = cast(
+            int, self._interface.write_register_and_mask(addr, value)
+        )
         if result < 0:
             raise PN5180Error("write_register_and_mask", result)
 
-    def write_register_multiple(self, elements: List[Tuple[int, int, int]]) -> None:
+    def write_register_multiple(
+        self, elements: List[Tuple[int, int, int]]
+    ) -> None:
         """Write to multiple PN5180 registers.
 
         Args:
@@ -268,7 +272,8 @@ def read_register_multiple(self, addrs: List[int]) -> List[int]:
         for i, addr in enumerate(addrs):
             self._validate_uint8(addr, f"addrs[{i}]")
         result = cast(
-            Tuple[int, List[int]], self._interface.read_register_multiple(addrs)
+            Tuple[int, List[int]],
+            self._interface.read_register_multiple(addrs),
         )
         if result[0] < 0:
             raise PN5180Error("read_register_multiple", result[0])
@@ -416,7 +421,9 @@ def mifare_authenticate(
         self._validate_uint32(uid, "uid")
         result = cast(
             int,
-            self._interface.mifare_authenticate(list(key), key_type, block_addr, uid),
+            self._interface.mifare_authenticate(
+                list(key), key_type, block_addr, uid
+            ),
         )
         if result < 0:
             raise PN5180Error("mifare_authenticate", result)
@@ -445,7 +452,9 @@ def epc_inventory(
         """
         if len(select_command) > 39:
             raise ValueError("select_command must be at most 39 bytes")
-        self._validate_uint8(select_command_final_bits, "select_command_final_bits")
+        self._validate_uint8(
+            select_command_final_bits, "select_command_final_bits"
+        )
         if len(begin_round) != 3:
             raise ValueError("begin_round must be exactly 3 bytes")
         if timeslot_behavior not in (
@@ -489,7 +498,9 @@ def epc_retrieve_inventory_result_size(self) -> int:
         Raises:
             PN5180Error: If the operation fails.
         """
-        result = cast(int, self._interface.epc_retrieve_inventory_result_size())
+        result = cast(
+            int, self._interface.epc_retrieve_inventory_result_size()
+        )
         if result < 0:
             raise PN5180Error("epc_retrieve_inventory_result_size", result)
         return result
@@ -506,7 +517,9 @@ def load_rf_config(self, tx_config: int, rx_config: int) -> None:
         """
         self._validate_uint8(tx_config, "tx_config")
         self._validate_uint8(rx_config, "rx_config")
-        result = cast(int, self._interface.load_rf_config(tx_config, rx_config))
+        result = cast(
+            int, self._interface.load_rf_config(tx_config, rx_config)
+        )
         if result < 0:
             raise PN5180Error("load_rf_config", result)