esp-idf-defs 0.1.0__tar.gz

esp_idf_defs-0.1.0/.github/workflows/build.yml

@@ -0,0 +1,42 @@
+name: Publish esp-idf-defs
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Build package
+        run: |
+          pip install build
+          python -m build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

esp_idf_defs-0.1.0/.gitignore

@@ -0,0 +1,65 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+env/
+build/
+build-*/
+develop-eggs/
+dist/
+dist-*/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# pyenv
+.python-version
+
+# dotenv
+.env
+
+# virtualenv
+venv/
+ENV/
+
+### VirtualEnv template
+# Virtualenv
+# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/
+[Bb]in
+[Ii]nclude
+[Ll]ib
+[Ll]ib64
+[Ll]ocal
+[Ss]cripts
+pyvenv.cfg
+.venv
+pip-selfcheck.json
+
+# File-based project format
+*.iws
+
+# idea folder
+.idea

esp_idf_defs-0.1.0/LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may accept and charge a
+      fee for the acceptance of support, warranty, indemnity, or other
+      liability obligations and/or rights consistent with this License.
+      However, in accepting such obligations, You may act only on Your
+      own behalf and on Your sole responsibility, not on behalf of any
+      other Contributor, and only if You agree to indemnify, defend, and
+      hold each Contributor harmless for any liability incurred by, or
+      claims asserted against, such Contributor by reason of your
+      accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Nebojša Cvetković
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

esp_idf_defs-0.1.0/PKG-INFO

@@ -0,0 +1,5 @@
+Metadata-Version: 2.4
+Name: esp-idf-defs
+Version: 0.1.0
+License-File: LICENSE.md
+Dynamic: license-file

esp_idf_defs-0.1.0/README.md

@@ -0,0 +1,53 @@
+# esp-idf-defs
+
+Python data structures for ESP-IDF internals — partition tables, firmware image headers, OTA data, and application descriptors.
+
+Used by [`idftool`](https://github.com/nebkat/idftool).
+
+## Installation
+
+```bash
+pip install esp-idf-defs
+```
+
+## Classes
+
+### Partition table
+
+```python
+from esp_idf_defs import PartitionTable, PartitionDefinition
+
+table = PartitionTable.from_binary(data)   # parse binary partition table
+table = PartitionTable.from_csv(text)      # parse CSV partition table
+
+partition = table["ota_0"]                 # look up by name
+print(partition.offset, partition.size)
+```
+
+### Firmware images
+
+```python
+from esp_idf_defs import ImageMetadata
+
+image = ImageMetadata.from_binary(data)
+print(image.header.chip_id, image.app_description.version)
+```
+
+### OTA data
+
+```python
+from esp_idf_defs import OtaDataSelectEntry
+from esp_idf_defs.otadata import OtaDataParameters
+
+entry = OtaDataSelectEntry.from_binary(data)
+print(entry.ota_seq, entry.state)
+```
+
+### Application descriptor
+
+```python
+from esp_idf_defs import AppDescription
+
+desc = AppDescription.from_binary(data)
+print(desc.project_name, desc.version)
+```

esp_idf_defs-0.1.0/esp_idf_defs/__init__.py

@@ -0,0 +1,22 @@
+__all__ = [
+    "AppDescription",
+    "ImageMetadata",
+    "ImageHeader",
+    "ImageSegment",
+    "ImageSpiMode",
+    "ImageSpiFrequency",
+    "ChipId",
+    "ImageFlashSize",
+    "OtaDataSelectEntry",
+    "PartitionTable",
+    "PartitionDefinition"
+]
+
+from esp_idf_defs.image_metadata import ImageMetadata, ImageHeader, ImageSegment, ImageSpiMode, ImageSpiFrequency, \
+    ChipId, ImageFlashSize
+
+from esp_idf_defs.otadata import OtaDataSelectEntry
+
+from esp_idf_defs.partitions import PartitionTable, PartitionDefinition
+
+from esp_idf_defs.app_description import AppDescription

esp_idf_defs-0.1.0/esp_idf_defs/app_description.py

@@ -0,0 +1,90 @@
+from __future__ import annotations
+import struct
+from dataclasses import dataclass
+from typing import ClassVar
+
+
+@dataclass
+class AppDescription:
+    # `ESP_APP_DESC_MAGIC_WORD`
+    MAGIC: ClassVar[int] = 0xABCD5432
+
+    # sizeof(esp_image_header_t) + sizeof(esp_image_segment_header_t)
+    FIRMWARE_BINARY_OFFSET: ClassVar[int] = 0x20
+
+    # `sizeof(esp_app_desc_t)`
+    SIZE: ClassVar[int] = 256
+
+    project_name: str
+    version: str
+    idf_version: str
+    secure_version: int
+    elf_sha256: bytes
+    time: str | None = None
+    date: str | None = None
+
+    @property
+    def title(self) -> str:
+        return f"{self.project_name} {self.version}"
+
+    @property
+    def compiled(self) -> str | None:
+        if self.date and self.time:
+            return f"{self.date} {self.time}"
+        return None
+
+    @classmethod
+    def from_bytes(cls, buffer: bytes) -> AppDescription:
+        if len(buffer) < cls.SIZE:
+            raise ValueError(f"Invalid app description, expected >= 256 bytes, got {len(buffer)}")
+
+        if struct.unpack_from('<I', buffer, 0)[0] != cls.MAGIC:
+            raise ValueError("Invalid firmware file, magic not found")
+
+        def decode_string(start, length):
+            return buffer[start:start + length].split(b'\x00', 1)[0].decode('utf-8')
+
+        project_name = decode_string(48, 32)
+        version = decode_string(16, 32)
+        idf_version = decode_string(112, 32)
+        secure_version = struct.unpack_from('<I', buffer, 4)[0]
+
+        time = decode_string(80, 16)
+        date = decode_string(96, 16)
+
+        elf_sha256 = buffer[144:176]
+
+        return cls(
+            project_name=project_name,
+            version=version,
+            idf_version=idf_version,
+            secure_version=secure_version,
+            time=time,
+            date=date,
+            elf_sha256=elf_sha256
+        )
+
+    @classmethod
+    def from_bytes_or_none(cls, buffer: bytes) -> AppDescription | None:
+        try:
+            return cls.from_bytes(buffer)
+        except ValueError:
+            return None
+
+    def to_bytes(self) -> bytes:
+        def encode_field(value: str | None, length: int) -> bytes:
+            """Helper function to encode a string or None into a fixed-length byte array."""
+            if value:
+                return value.encode('utf-8')[:length].ljust(length, b'\x00')
+            return b'\x00' * length
+
+        buffer = bytearray(self.SIZE)
+        struct.pack_into('<I', buffer, 0, self.MAGIC)
+        struct.pack_into('<I', buffer, 4, self.secure_version)
+        buffer[48:80] = encode_field(self.project_name, 32)
+        buffer[16:48] = encode_field(self.version, 32)
+        buffer[112:144] = encode_field(self.idf_version, 32)
+        buffer[80:96] = encode_field(self.time, 16)
+        buffer[96:112] = encode_field(self.date, 16)
+        buffer[144:176] = self.elf_sha256
+        return bytes(buffer)

esp_idf_defs-0.1.0/esp_idf_defs/image_metadata.py

@@ -0,0 +1,178 @@
+from __future__ import annotations
+
+import collections
+import struct
+from dataclasses import dataclass
+from enum import IntEnum
+from functools import reduce
+from hashlib import sha256
+from typing import ClassVar, NamedTuple, List
+
+from esp_idf_defs.app_description import AppDescription
+
+
+@dataclass
+class ImageMetadata:
+    """ESP-IDF firmware image metadata (`esp_image_metadata_t`)"""
+
+    # `ESP_ROM_CHECKSUM_INITIAL` / `ESP_CHECKSUM_MAGIC`
+    CHECKSUM_MAGIC: ClassVar[int] = 0xEF
+
+    header: ImageHeader
+    segments: List[ImageSegment]
+    digest: bytes
+    app_description: AppDescription | None
+
+    @classmethod
+    def from_bytes(cls, buffer: bytes, app_required: bool = False) -> ImageMetadata:
+        header = ImageHeader.from_bytes(buffer[0:ImageHeader.SIZE])
+        offset = ImageHeader.SIZE
+        segments: List[ImageSegment] = []
+        checksum = ImageMetadata.CHECKSUM_MAGIC
+        app_description: AppDescription | None = None
+        for i in range(header.segment_count):
+            if offset + 8 >= len(buffer):
+                raise ValueError(f"Segment {i} out of range (not enough data)")
+            address, length = struct.unpack_from('<II', buffer, offset)
+            offset += 8
+            segment = ImageSegment(offset, length, address)
+
+            data = buffer[offset:offset+length]
+            checksum = reduce(lambda a, b: a ^ b & 0xFF, data, checksum)
+
+            if i == 0:
+                app_description = AppDescription.from_bytes(data) if app_required else AppDescription.from_bytes_or_none(data)
+
+            offset += length
+            segments.append(segment)
+
+        # Add a byte for the checksum
+        offset += 1
+
+        # Pad to the next full 16 byte block
+        offset = (offset + 15) & ~0xF
+
+        # Checksum (simple)
+        expected_checksum = struct.unpack_from('<B', buffer, offset - 1)[0]
+        if checksum != expected_checksum:
+            raise ValueError(f"Checksum mismatch: expected {expected_checksum:#02x}, got {checksum:#02x}")
+
+        # Hash (SHA-256)
+        digest = sha256(buffer[:offset]).digest()
+        if header.hash_appended:
+            expected_hash = buffer[offset:offset+32]
+            if digest != expected_hash:
+                raise ValueError(f"SHA-256 hash mismatch: expected {expected_hash.hex()}, got {digest.hex()}")
+
+        return cls(
+            header=header,
+            segments=segments,
+            digest=digest,
+            app_description=app_description
+        )
+
+
+
+@dataclass
+class ImageHeader:
+    # `ESP_IMAGE_HEADER_MAGIC`
+    MAGIC: ClassVar[int] = 0xE9
+
+    # `ESP_IMAGE_HEADER_MAGIC`
+    MAX_SEGMENTS: ClassVar[int] = 16
+
+    # `sizeof(esp_image_header_t)`
+    SIZE: ClassVar[int] = 24
+
+    # `WP_PIN_DISABLED`
+    WP_PIN_DISABLED: ClassVar[int] = 0xEE
+
+    @classmethod
+    def from_bytes(cls, buffer: bytes) -> ImageHeader:
+        if len(buffer) < cls.SIZE:
+            raise ValueError(f"Invalid image header, expected >= 24 bytes, got {len(buffer)}")
+
+        magic = struct.unpack_from('<B', buffer, 0)[0]
+        if magic != cls.MAGIC:
+            raise ValueError(f"Invalid image header, magic not found: expected {cls.MAGIC:#02x}, got {magic:#02x}")
+
+        segment_count = struct.unpack_from('<B', buffer, 1)[0]
+        if segment_count == 0 or segment_count > cls.MAX_SEGMENTS:
+            raise ValueError(
+                f"Invalid image header, bad segment count: {segment_count}: "
+                f"expected 1..{cls.MAX_SEGMENTS}")
+
+        wp_pin = struct.unpack_from('<B', buffer, 8)[0]
+
+        return cls(
+            segment_count=segment_count,
+            spi_mode = ImageSpiMode(struct.unpack_from('<B', buffer, 2)[0]),
+            spi_frequency = ImageSpiFrequency(struct.unpack_from('<B', buffer, 3)[0] & 0xF),
+            spi_size = ImageFlashSize(struct.unpack_from('<B', buffer, 3)[0] >> 4),
+            entry_address = struct.unpack_from('<I', buffer, 4)[0],
+            wp_pin = wp_pin if wp_pin != cls.WP_PIN_DISABLED else None,
+            spi_pin_drv = struct.unpack_from('<BBB', buffer, 9),
+            chip_id = ChipId(struct.unpack_from('<H', buffer, 12)[0]),
+            min_chip_rev = struct.unpack_from('<B', buffer, 14)[0],
+            min_chip_rev_full = struct.unpack_from('<H', buffer, 15)[0],
+            max_chip_rev_full = struct.unpack_from('<H', buffer, 11)[0],
+            hash_appended = bool(struct.unpack_from('<B', buffer, 23)[0] == 1)
+        )
+
+    segment_count: int
+    spi_mode: ImageSpiMode | None
+    spi_frequency: ImageSpiFrequency | None
+    spi_size: ImageFlashSize | None
+    entry_address: int
+    wp_pin: int | None
+    spi_pin_drv: (int, int, int)
+    chip_id: ChipId | None
+    min_chip_rev: int
+    min_chip_rev_full: int
+    max_chip_rev_full: int
+    hash_appended: bool
+
+ImageSegment = NamedTuple("ImageSegment", [
+    ("offset", int),
+    ("length", int),
+    ("address", int)
+])
+
+# `esp_image_spi_mode_t`
+class ImageSpiMode(IntEnum):
+    QIO = 0x0
+    QOUT = 0x1
+    DIO = 0x2
+    DOUT = 0x3
+    FAST_READ = 0x4
+    SLOW_READ = 0x5
+
+# `esp_image_spi_freq_t`
+class ImageSpiFrequency(IntEnum):
+    DIV1 = 0xF
+    DIV2 = 0x0
+    DIV3 = 0x1
+    DIV4 = 0x2
+
+# `esp_chip_id_t`
+class ChipId(IntEnum):
+    ESP32 = 0x0000
+    ESP32S2 = 0x0002
+    ESP32C3 = 0x0005
+    ESP32S3 = 0x0009
+    ESP32C2 = 0x000C
+    ESP32C6 = 0x000D
+    ESP32H2 = 0x0010
+    ESP32P4 = 0x0012
+    ESP32C5 = 0x0017
+
+# `esp_image_flash_size_t`
+class ImageFlashSize(IntEnum):
+    MB1 = 0x0
+    MB2 = 0x1
+    MB4 = 0x2
+    MB8 = 0x3
+    MB16 = 0x4
+    MB32 = 0x5
+    MB64 = 0x6
+    MB128 = 0x7