indi_blob.py

# -*- coding: utf-8 -*-
########################################################################################################################
# NyxNode
# Author: Jérôme ODIER <jerome.odier@lpsc.in2p3.fr>
# SPDX-License-Identifier: GPL-3.0+
########################################################################################################################
 
import ctypes
import typing
 
########################################################################################################################
 
from .. import obj
from .. import bind
from .. import json
 
from . import enums
from . import utils
 
########################################################################################################################
 
## @defgroup BLOB_MESSAGE_PY Nyx BLOB Message
#  @brief Nyx / INDI BLOB Message.
 
########################################################################################################################
 
@utils.nyx_property(
    'name',
    '@name',
)
@utils.nyx_property(
    'label',
    '@label',
)
@utils.nyx_property(
    'format',
    '@format',
)
@utils.nyx_property(
    'value',
    '$',
    kind = bytes,
)
class NyxBLOBProp(json.json_dict.NyxDict):
    """!
    @ingroup BLOB_MESSAGE_PY
    @brief INDI / Nyx BLOB property.
    """
 
    ####################################################################################################################
 
    def __init__(self, name: str, label: str | None = None, fmt: str | None = None, value: bytes | None = None):
        """!
        @brief Allocates a new INDI / Nyx BLOB property.
 
        @param name Property name.
        @param label Property label.
        @param fmt Payload format.
        @param value Initial payload buffer.
 
        @note If a format ends with `.z`, the payload is automatically ZLib+Base64-compressed, otherwise, the payload is automatically Base64-encoded.
        """
 
        ################################################################################################################
 
        data = bind.as_bytes(value, allow_none = False)
 
        buff = ctypes.cast(bind.lib.nyx_buffer_ndup(data, len(data)), bind.c_void_p)
 
        ################################################################################################################
 
        super().__init__(bind.lib.nyx_blob_prop_new(
            bind.as_bytes(name, allow_none = False),
            bind.as_bytes(label, allow_none = True),
            bind.as_bytes(fmt, allow_none = True),
            len(data),
            buff,
            True,
        ))
 
    ####################################################################################################################
 
    @obj.nyx_callback(bind.nyx_callback_buffer_t)
    def _nyx_callback_func(self, _vector, _prop, size, buff) -> bool:
 
        return all(self._dispatch_callbacks(ctypes.string_at(buff, size) if buff is not None and size > 0 else b''))
 
########################################################################################################################
 
@utils.nyx_property(
    'device',
    '@device',
)
@utils.nyx_property(
    'name',
    '@name',
)
@utils.nyx_property(
    'state',
    '@state',
    getter = enums.NyxState.to_int,
    setter = enums.NyxState.to_str,
)
@utils.nyx_property(
    'perm',
    '@perm',
    getter = enums.NyxPerm.to_int,
    setter = enums.NyxPerm.to_str,
)
class NyxBLOBVector(json.json_dict.NyxDict):
    """!
    @ingroup BLOB_MESSAGE_PY
    @brief INDI / Nyx BLOB vector.
    """
 
    ####################################################################################################################
 
    def __init__(self, device: str, name: str, state: enums.NyxState | int | str, perm: enums.NyxPerm | int | str, props: typing.Iterable[NyxBLOBProp], **opts: typing.Any):
        """!
        @brief Allocates a new INDI / Nyx BLOB vector.
 
        @param device Device name.
        @param name Vector name.
        @param state Vector state.
        @param perm Vector permissions.
        @param props Properties.
        @param opts Options (group, label, hints, timeout, message).
        """
 
        ################################################################################################################
 
        super().__init__(bind.lib.nyx_blob_vector_new(
            bind.as_bytes(device, allow_none = False),
            bind.as_bytes(name, allow_none = False),
            enums.NyxState.to_int(state),
            enums.NyxPerm.to_int(perm),
            bind.nyx_dict_p(),
            bind.as_opts(opts),
        ))
 
        ################################################################################################################
 
        # noinspection PyTypeChecker
        children: json.NyxList = self['children']
 
        for prop in props:
 
            if not isinstance(prop, NyxBLOBProp):
 
                raise TypeError('Expected NyxBlobProp')
 
            children.append(prop)
 
    ####################################################################################################################
 
    @obj.nyx_callback(bind.nyx_callback_vector_t)
    def _nyx_callback_func(self, _vector: json.json_dict.NyxDict, modified: bool) -> None:
 
        self._dispatch_callbacks(bool(modified))
 
########################################################################################################################
 
__all__ = [name for name in globals() if name.lower().startswith('nyx')]
 
########################################################################################################################