{"id":22923500,"url":"https://github.com/ams-osram/osp_aoresult","last_synced_at":"2026-06-23T22:04:15.306Z","repository":{"id":247406782,"uuid":"823612432","full_name":"ams-OSRAM/OSP_aoresult","owner":"ams-OSRAM","description":"A library that defines all error codes that may occur in any of the OSP libraries.","archived":false,"fork":false,"pushed_at":"2025-04-22T13:30:31.000Z","size":61,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-22T14:34:56.939Z","etag":null,"topics":["arduino","as1163","e3731i","library","osp","rgb-led"],"latest_commit_sha":null,"homepage":"https://github.com/ams-OSRAM/OSP_aotop","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ams-OSRAM.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-03T11:14:35.000Z","updated_at":"2025-04-22T13:28:57.000Z","dependencies_parsed_at":"2024-07-08T16:18:31.750Z","dependency_job_id":null,"html_url":"https://github.com/ams-OSRAM/OSP_aoresult","commit_stats":null,"previous_names":["ams-osram-group/osp_aoresult","ams-osram/osp_aoresult"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/ams-OSRAM/OSP_aoresult","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ams-OSRAM%2FOSP_aoresult","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ams-OSRAM%2FOSP_aoresult/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ams-OSRAM%2FOSP_aoresult/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ams-OSRAM%2FOSP_aoresult/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ams-OSRAM","download_url":"https://codeload.github.com/ams-OSRAM/OSP_aoresult/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ams-OSRAM%2FOSP_aoresult/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271330312,"owners_count":24740819,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-20T02:00:09.606Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arduino","as1163","e3731i","library","osp","rgb-led"],"created_at":"2024-12-14T08:15:53.561Z","updated_at":"2026-06-23T22:04:15.301Z","avatar_url":"https://github.com/ams-OSRAM.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OSP ResultCodes aoresult\n\nLibrary \"OSP ResultCodes aoresult\", usually abbreviated to \"aoresult\",\nis one of the **aolibs**; short for Arduino OSP libraries from ams-OSRAM.\nThis suite implements support for chips that use the Open System Protocol, \nlike the AS1163 (\"SAID\") or the OSIRE E3731i (\"RGBi\").\nThe landing page for the _aolibs_ is on \n[GitHub](https://github.com/ams-OSRAM/OSP_aotop).\n\n\n## Introduction\n\nLibrary _aoresult_ is at the base of the dependency graph.\nIt contains (defines) a list of all error codes that\nmay occur in any of the _aolibs_.\nAs a result, library _aoresult_ is relatively empty.\n\n![aoresult in context](extras/aolibs-aoresult.drawio.png)\n\nThe error codes could have been integrated in the next library \nin the hierarchy (_aospi_), and _aoresult_ would be superfluous. \nHowever, _aospi_ likely needs variants (supporting other MCUs, \n1-wire SPI, dropping mux support) so splitting off the error codes \nin a separate library _aoresult_ makes sense.\n\n\n## Examples\n\nThis library comes with the following examples.\nYou can find them in the Arduino IDE via \n[File \u003e Examples \u003e OSP ResultCodes aoresult \u003e ...](examples):\n\n- **aoresult_demo** ([source](examples/aoresult_demo))  \n  This demo shows how to convert the result codes from the aoresult lib\n  to strings.\n\n- **aoresult_assert** ([source](examples/aoresult_assert))  \n  This demo shows how to use the assert feature of the aoresult library.\n  Patch the definition of `AORESULT_ASSERT` if a debugger is attached.\n\n\n## API\n\nThe header [aoresult.h](src/aoresult.h) contains the API of this library.\nThe header contains little documentation; for that see the\n[aoresult.cpp](src/aoresult.cpp) source file. \n\nHere is a quick overview:\n\n- `aoresult_t` the global list of error codes in the _aolibs_ (enumeration data type).\n\n- `aoresult_to_str(result)` converts an error code to a (short) string or a (longer) description.\n\n- `AORESULT_ASSERT(cond)` Checks if `cond` holds, if not, prints error to `Serial`, and stops.\n   Uses helper function `aoresult_shorten(filename)`.\n\n- Finally, there is the macro `AORESULT_VERSION`, which identifies the version of the library.\n\n\n## Version history _aoresult_\n\n- **2026 April 21, 0.6.0**\n  - Added error `aoresult_dev_wrongval` to support I2C devices with different revisions, markers or CRC.\n    Updated `aoresult_demo.ino` OUTPUT section.\n\n- **2025 September 16, 0.5.0**\n  - Added error `aoresult_dev_i2cmode` and `aoresult_osp_argsize` to better support I2C in modes 8 and 12.\n  - Added link to examples.\n\n- **2025 April 22, 0.4.6**\n  - Made `aoresult.h` self contained: added `#include \u003cArduino.h\u003e` for `Serial` in `AORESULT_ASSERT()`.\n\n- **2024 November 29, 0.4.5**\n  - Added error `aoresult_osp_nosr` for missing acknowledge.\n  - Small updates in `aoresult_demo.ino`.\n  - Fixed a typo.\n\n- **2024 October 22, 0.4.4**\n  - Removed hard coupling from names to integers; added `aoresult_numresultcodes`.\n  - Added `aoresult_osp_psi`.\n\n- **2024 October 8, 0.4.3**\n  - Explained why separate library.\n\n- **2024 October 7, 0.4.2**\n  - Small textual updates of error messages\n  - Moved domain from `github.com/ams-OSRAM-Group` to `github.com/ams-OSRAM`.\n  \n- **2024 September 5, 0.4.1**\n  - Split example `aoresult_assert.ino` from `aoresult_demo.ino`.\n  - API section in readme now shows parameter names.\n\n- **2024 August 28, 0.4.0**\n  - Added links in `readme.md` for all example sketches.\n  - Added error `aoresult_sys_nodecfg`.\n\n- **2024 August 9, 0.3.0**\n  - Added error `aoresult_sys_wrongtopo`.\n\n- **2024 August 5, 0.2.1**  \n  - Corrected landing page link in readme.md from aotop to OSP_aotop.\n  - Remove \"oalib\" from `sentence=` in `library.properties`.\n  - Extra (indent) spaces in `aoresult_shorten()`.\n\n- **2024 July 7, 0.2.0**  \n  - Arduino name changed from `OSP Result codes - aoresult` to `OSP ResultCodes aoresult`.\n  - Renamed dir `extra` to `extras`.\n\n- **2024 July 3, 0.1.11**  \n  - `license.txt`, `aoresult_demo.ino` line endings changed from LF to CR+LF.\n\n- **2024 July 02, 0.1.10**  \n  - Initial release candidate.\n\n(end)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fams-osram%2Fosp_aoresult","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fams-osram%2Fosp_aoresult","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fams-osram%2Fosp_aoresult/lists"}