0.5.0

- Added error `aoresult_dev_i2cmode` and `aoresult_osp_argsize` to better support I2C in modes 8 and 12.
- Added link to examples.

Author: Maarten Pennings

library.properties

@@ -1,5 +1,5 @@
 name=OSP ResultCodes aoresult
-version=0.4.6
+version=0.5.0
 author=ams-OSRAM
 maintainer=ams-OSRAM
 sentence=A library that defines all error codes that may occur in any of the OSP libraries.

readme.md

@@ -28,7 +28,7 @@ in a separate library _aoresult_ makes sense.
 
 This library comes with the following examples.
 You can find them in the Arduino IDE via 
-File > Examples > OSP ResultCodes aoresult > ...
+[File > Examples > OSP ResultCodes aoresult > ...](examples):
 
 - **aoresult_demo** ([source](examples/aoresult_demo))  
   This demo shows how to convert the result codes from the aoresult lib
@@ -59,9 +59,13 @@ Here is a quick overview:
 
 ## Version history _aoresult_
 
+- **2025 September 16, 0.5.0**
+  - Added error `aoresult_dev_i2cmode` and `aoresult_osp_argsize` to better support I2C in modes 8 and 12.
+  - Added link to examples.
+
 - **2025 April 22, 0.4.6**
   - Made `aoresult.h` self contained: added `#include <Arduino.h>` for `Serial` in `AORESULT_ASSERT()`.
-  
+
 - **2024 November 29, 0.4.5**
   - Added error `aoresult_osp_nosr` for missing acknowledge.
   - Small updates in `aoresult_demo.ino`.

src/aoresult.cpp

@@ -1,6 +1,6 @@
 // aoresult.cpp - list of all error codes in any of the aolibs.
 /*****************************************************************************
- * Copyright 2024 by ams OSRAM AG                                            *
+ * Copyright 2024,2025 by ams OSRAM AG                                       *
  * All rights are reserved.                                                  *
  *                                                                           *
  * IMPORTANT - PLEASE READ CAREFULLY BEFORE COPYING, INSTALLING OR USING     *
@@ -48,7 +48,8 @@ const char * aoresult_to_str(aoresult_t result, int verbose) {
     case aoresult_spi_noclock      : return verbose==0 ? "spi_noclock"     : "No clock signal detected for response telegram";
     case aoresult_spi_length       : return verbose==0 ? "spi_length"      : "Response telegram length differs from requested";
 
-    case aoresult_osp_arg          : return verbose==0 ? "osp_arg"         : "An OSP telegram argument has an illegal value";
+    case aoresult_osp_arg          : return verbose==0 ? "osp_arg"         : "An OSP telegram argument has an illegal (out of range) value";
+    case aoresult_osp_argsize      : return verbose==0 ? "osp_argsize"     : "An OSP telegram (buf) argument causes illegal telegram size";
     case aoresult_osp_addr         : return verbose==0 ? "osp_addr"        : "The address for an OSP telegram is illegal";
     case aoresult_osp_preamble     : return verbose==0 ? "osp_preamble"    : "Preamble incorrect in response telegram";
     case aoresult_osp_tid          : return verbose==0 ? "osp_tid"         : "Unexpected telegram ID in response telegram";
@@ -66,6 +67,7 @@ const char * aoresult_to_str(aoresult_t result, int verbose) {
     case aoresult_dev_noi2cdev     : return verbose==0 ? "dev_noi2cdev"    : "Missing specific I2C device (eg app needs EEPROM or I/O-expander)";
     case aoresult_dev_i2ctimeout   : return verbose==0 ? "dev_i2ctimeout"  : "I2C transaction took too long to complete";
     case aoresult_dev_i2cnack      : return verbose==0 ? "dev_i2cnack"     : "I2C transaction completed with NACK";
+    case aoresult_dev_i2cmode      : return verbose==0 ? "dev_i2cmode"     : "I2C telegram not compatible with (8 or12 bit) mode";
 
     case aoresult_numresultcodes   : return verbose==0 ? "<illegal>"       : "Illegal error code aoresult_numresultcodes";
   }

src/aoresult.h

@@ -26,7 +26,7 @@
 
 
 // Identifies lib version
-#define AORESULT_VERSION "0.4.6"
+#define AORESULT_VERSION "0.5.0"
 
 
 // For detailed meaning, see aoresult_to_str()
@@ -46,27 +46,29 @@ typedef enum aoresult_e {
 
   // Errors for aoosp
   aoresult_osp_arg         , //  9
-  aoresult_osp_addr        , // 10
-  aoresult_osp_preamble    , // 11
-  aoresult_osp_tid         , // 12
-  aoresult_osp_size        , // 13
-  aoresult_osp_psi         , // 14
-  aoresult_osp_crc         , // 15
-  aoresult_osp_nosr        , // 16
+  aoresult_osp_argsize     , // 10
+  aoresult_osp_addr        , // 11
+  aoresult_osp_preamble    , // 12
+  aoresult_osp_tid         , // 13
+  aoresult_osp_size        , // 14
+  aoresult_osp_psi         , // 15
+  aoresult_osp_crc         , // 16
+  aoresult_osp_nosr        , // 17
 
   // Errors on OSP system
-  aoresult_sys_cabling     , // 17
-  aoresult_sys_id          , // 18
-  aoresult_sys_wrongtopo   , // 19
-  aoresult_sys_nodecfg     , // 20
+  aoresult_sys_cabling     , // 18
+  aoresult_sys_id          , // 19
+  aoresult_sys_wrongtopo   , // 20
+  aoresult_sys_nodecfg     , // 21
 
   // Errors for attached devices
-  aoresult_dev_noi2cbridge , // 21
-  aoresult_dev_noi2cdev    , // 22
-  aoresult_dev_i2ctimeout  , // 23
-  aoresult_dev_i2cnack     , // 24
+  aoresult_dev_noi2cbridge , // 22
+  aoresult_dev_noi2cdev    , // 23
+  aoresult_dev_i2ctimeout  , // 24
+  aoresult_dev_i2cnack     , // 25
+  aoresult_dev_i2cmode     , // 26
 
-  aoresult_numresultcodes    // 25 keep this as last
+  aoresult_numresultcodes    // 27 keep this as last
 } aoresult_t;