add get_component_versions

Author: drebbe-intrepid

include/methods.h

@@ -101,8 +101,9 @@ extern "C"
     PyObject* meth_flash_accessory_firmware(PyObject* self, PyObject* args);
     PyObject* meth_get_accessory_firmware_version(PyObject* self, PyObject* args);
     PyObject* meth_set_safe_boot_mode(PyObject* self, PyObject* args);
-    PyObject* meth_get_device_name(PyObject* self, PyObject* args); // icsneoGetDeviceName
-    PyObject* meth_get_imei(PyObject* self, PyObject* args);        // icsneoGetIMEI
+    PyObject* meth_get_device_name(PyObject* self, PyObject* args);        // icsneoGetDeviceName
+    PyObject* meth_get_imei(PyObject* self, PyObject* args);               // icsneoGetIMEI
+    PyObject* meth_get_component_versions(PyObject* self, PyObject* args); // icsneoGetComponentVersions
 
 #ifdef _cplusplus
 }
@@ -1959,6 +1960,21 @@ extern "C"
                 "\tint\n"                                                                                              \
                 "\n"
 
+#define _DOC_GET_COMPONENT_VERSIONS                                                                                    \
+    MODULE_NAME ".get_component_versions(device[, force, length]) -> (ics.structures.version_report.version_report)\n" \
+                "\n"                                                                                                   \
+                "Gets the component versions from the device.\n"                                                       \
+                "\n"                                                                                                   \
+                "Args:\n"                                                                                              \
+                "\tdevice (:class:`" MODULE_NAME ".PyNeoDeviceEx`): :class:`" MODULE_NAME ".PyNeoDeviceEx`\n\n"        \
+                "\n"                                                                                                   \
+                "Raises:\n"                                                                                            \
+                "\t:class:`" MODULE_NAME ".RuntimeError`\n"                                                            \
+                "\n"                                                                                                   \
+                "Returns:\n"                                                                                           \
+                "\ttuple of ics.structures.version_report.version_report\n"                                            \
+                "\n"
+
 extern PyMethodDef IcsMethods[];
 
 #endif // _METHODS_H_

src/ics/py_neo_device_ex.py

@@ -497,4 +497,8 @@ def get_device_name(self, *args, **kwargs):
 
     def get_imei(self, *args, **kwargs):
         "see ics.get_imei for details on arguments."
-        return ics.get_imei(self, *args, **kwargs)
+        return ics.get_imei(self, *args, **kwargs)
+    
+    def get_component_versions(self, *args, **kwargs):
+        "see ics.get_component_versions for details on arguments."
+        return ics.get_component_versions(self, *args, **kwargs)

src/icsdebug.py

@@ -1,24 +1,43 @@
+import os
+
+input(os.getpid())
+
 import ics
+import struct
+
+ics.override_library_name(r"C:\dev\vspy3\Binaries\win64\icsneo40.dll")
+
+CHIP_IDs = {
+    82: "FIRE3_ZCHIP_ID",
+    109: "NEOVI_FIRE3_LINUX_ID",
+    121: "NEOVI_CONNECT_ZCHIP_ID",
+    126: "NEOVI_FIRE3_LINUX_ID",
+}
 
-def show_clients():
-    for d in ics.find_devices():
-        print(d, d.NumberOfClients)
+def dot_version(version: int) -> str:
+    version = '.'.join(str(x) for x in struct.unpack("4B", version.to_bytes(4, byteorder='big')))
+    return version.lstrip('0.')
 
-print("Find...")
-devices = ics.find_devices()
-show_clients()
-print("Devices: ", devices)
-d = ics.open_device(devices[0])
-show_clients()
-print("Opened", d)
-print("Loading default settings...", d)
-ics.load_default_settings(d)
-print("Closing...")
-print(ics.close_device(d))
-print("Done.")
+def linux_state(component_info: int) -> str:
+    match component_info:
+        case 1:
+            return "SD Card/MMC Partition 2"
+        case 2:
+            return "SD Card/MMC Partition 3"
+        case 3:
+            return "RAM"
+        case _:
+            return f"Unknown {component_info}"
 
-# New Style
-d = devices[0]
-d.open(config_read=0)
-d.load_default_settings()
-d.close()
+d = ics.open_device()
+print(str(d))
+versions = d.get_component_versions()
+for version in versions:
+    print(f"\t{version.valid}")
+    print(f"\t{version.expansionSlot}")
+    print(f"\t{version.componentInfo}: {linux_state(version.componentInfo)}")
+    print(f"\t{version.reserved}")
+    print(f"\t{version.identifier}: {CHIP_IDs[version.identifier]}")
+    print(f"\t{version.dotVersion}: {dot_version(version.dotVersion)}")
+    print(f"\t{version.commitHash}")
+    print()

src/methods.cpp

@@ -614,6 +614,15 @@ PyMethodDef IcsMethods[] = {
                           meth_get_imei,
                           METH_VARARGS,
                           _DOC_GET_IMEI),
+    _EZ_ICS_STRUCT_METHOD("get_component_versions",
+                          "icsneoGetComponentVersions",
+                          "GetComponentVersions",
+                          meth_get_component_versions,
+                          METH_VARARGS,
+                          _DOC_GET_COMPONENT_VERSIONS),
+
+
+                          
 
     { "override_library_name", (PyCFunction)meth_override_library_name, METH_VARARGS, _DOC_OVERRIDE_LIBRARY_NAME },
     { "get_library_path", (PyCFunction)meth_get_library_path, METH_NOARGS, "" },
@@ -5486,3 +5495,65 @@ PyObject* meth_get_imei(PyObject* self, PyObject* args) { // icsneoGetIMEI
         return set_ics_exception(exception_runtime_error(), (char*)ex.what());
     }
 }
+
+PyObject* meth_get_component_versions(PyObject* self, PyObject* args) // icsneoGetComponentVersions
+{
+    (void)self;
+    PyObject* obj = NULL;
+    bool force_update = true;
+    uint64_t length = 25;
+    if (!PyArg_ParseTuple(args, arg_parse("O|bK:", __FUNCTION__), &obj, &force_update, &length)) {
+        return NULL;
+    }
+    if (!PyNeoDeviceEx_CheckExact(obj)) {
+        return set_ics_exception(exception_runtime_error(), "Argument must be of type " MODULE_NAME ".PyNeoDeviceEx");
+    }
+    void* handle = NULL;
+    if (!PyNeoDeviceEx_GetHandle(obj, &handle)) {
+        return NULL;
+    }
+    try {
+        ice::Library* lib = dll_get_library();
+        if (!lib) {
+            char buffer[512];
+            return set_ics_exception(exception_runtime_error(), dll_get_error(buffer));
+        }
+        uint64_t imei = 0;
+        ice::Function<int __stdcall(void*, VersionReport*, uint64_t*, bool)> icsneoGetComponentVersions(lib, "icsneoGetComponentVersions");
+        auto gil = PyAllowThreads();
+        std::vector<VersionReport> version_reports;
+        version_reports.reserve(length);
+        version_reports.resize(length);
+        if (!icsneoGetComponentVersions(handle, version_reports.data(), &length, force_update)) {
+            gil.restore();
+            return set_ics_exception(exception_runtime_error(), "icsneoGetComponentVersions() Failed");
+        }
+        gil.restore();
+
+        PyObject* tuple = PyTuple_New(length);
+        if (!tuple) {
+            return NULL;
+        }
+        for (int i = 0; i < length; ++i) {
+            PyObject* obj = _getPythonModuleObject("ics.structures.version_report", "version_report");
+            if (!obj) {
+                return set_ics_exception(exception_runtime_error(), "Failed to allocate version_report");
+            }
+
+
+
+            // Get the internal buffer from version_report
+            Py_buffer buffer = {};
+            if (PyObject_GetBuffer(obj, &buffer, PyBUF_CONTIG) != 0) {
+                return NULL;
+            }
+            memcpy(buffer.buf, &version_reports[i], sizeof(version_reports[i]));
+            PyBuffer_Release(&buffer);
+
+            PyTuple_SetItem(tuple, i, obj);
+        }
+        return tuple;
+    } catch (ice::Exception& ex) {
+        return set_ics_exception(exception_runtime_error(), (char*)ex.what());
+    }
+}