layrz-sdk 3.1.14__py3-none-any.whl → 3.1.16__py3-none-any.whl

layrz_sdk/entities/modbus/parameter.py

@@ -0,0 +1,110 @@
+from typing import Any
+
+from pydantic import BaseModel, Field, field_validator
+
+from .schema import ModbusSchema
+
+
+class ModbusParameter(BaseModel):
+  """Modbus parameter model"""
+
+  schema_: ModbusSchema = Field(
+    ...,
+    description='Modbus schema',
+    alias='schema',
+  )
+
+  split_each: int = Field(
+    ...,
+    description='Number of bytes to split each Modbus parameter',
+  )
+
+  @field_validator('split_each', mode='before')
+  def validate_split_each(cls, value: Any) -> int:
+    """Validate and convert split_each to integer."""
+    if isinstance(value, int):
+      return value
+
+    if isinstance(value, str):
+      try:
+        return int(value)
+      except ValueError as e:
+        raise ValueError(f'Invalid Modbus split_each value: {value}') from e
+
+    raise ValueError(f'Invalid Modbus split_each type: {type(value)}')
+
+  data_length: int = Field(
+    ...,
+    description='Length of data for the Modbus parameter, from Hexadecimal representation',
+  )
+
+  @field_validator('data_length', mode='before')
+  def validate_data_length(cls, value: Any) -> int:
+    """Validate and convert data_length to integer."""
+    if isinstance(value, int):
+      return value
+
+    if isinstance(value, str):
+      try:
+        return int(value, 16)  # Convert from hexadecimal string to integer
+      except ValueError as e:
+        raise ValueError(f'Invalid Modbus data_length value: {value}') from e
+
+    raise ValueError(f'Invalid Modbus data_length type: {type(value)}')
+
+  data_address: int = Field(
+    ...,
+    description='Address of the Modbus parameter, from Hexadecimal representation',
+  )
+
+  @field_validator('data_address', mode='before')
+  def validate_data_address(cls, value: Any) -> int:
+    """Validate and convert data_address to integer."""
+    if isinstance(value, int):
+      return value
+
+    if isinstance(value, str):
+      try:
+        return int(value, 16)  # Convert from hexadecimal string to integer
+      except ValueError as e:
+        raise ValueError(f'Invalid Modbus data_address value: {value}') from e
+
+    raise ValueError(f'Invalid Modbus data_address type: {type(value)}')
+
+  function_code: int = Field(
+    ...,
+    description='Function code for the Modbus parameter',
+  )
+
+  @field_validator('function_code', mode='before')
+  def validate_function_code(cls, value: Any) -> int:
+    """Validate and convert function_code to integer."""
+    if isinstance(value, int):
+      return value
+
+    if isinstance(value, str):
+      try:
+        return int(value, 16)  # Convert from hexadecimal string to integer
+      except ValueError as e:
+        raise ValueError(f'Invalid Modbus function_code value: {value}') from e
+
+    raise ValueError(f'Invalid Modbus function_code type: {type(value)}')
+
+  controller_address: int = Field(
+    ...,
+    description='Controller address for the Modbus parameter',
+  )
+
+  @field_validator('controller_address', mode='before')
+  def validate_controller_address(cls, value: Any) -> int:
+    """Validate and convert controller_address to integer."""
+    if isinstance(value, int):
+      return value
+
+    if isinstance(value, str):
+      try:
+        return int(value, 16)  # Convert from hexadecimal string to integer
+      except ValueError as e:
+        raise ValueError(f'Invalid Modbus controller_address value: {value}') from e
+
+    raise ValueError(f'Invalid Modbus controller_address type: {type(value)}')

layrz_sdk/entities/modbus/schema.py

@@ -0,0 +1,10 @@
+from enum import StrEnum
+
+
+class ModbusSchema(StrEnum):
+  """Modbus schema enumeration"""
+
+  SINGLE = 'SINGLE'
+  """ Defines a single Modbus request. """
+  MULTIPLE = 'MULTIPLE'
+  """ Defines multiple Modbus requests. """

layrz_sdk/entities/modbus/status.py

@@ -0,0 +1,16 @@
+from enum import StrEnum
+
+
+class ModbusStatus(StrEnum):
+  """Modbus schema enumeration"""
+
+  PENDING = 'PENDING'
+  """ Defines the pending state, indicating that the request is waiting to be processed. """
+  WAITING_FOR_SEND = 'WAITING_FOR_SEND'
+  """ Indicates that the request is ready to be sent but has not yet been dispatched. """
+  SENT = 'SENT'
+  """ Indicates that the request has been sent to the device. """
+  ACK_RECEIVED = 'ACK_RECEIVED'
+  """ Indicates that an acknowledgment has been received from the device. """
+  CANCELLED = 'CANCELLED'
+  """ Indicates that the request has been cancelled. """

layrz_sdk/entities/modbus/wait.py

@@ -0,0 +1,134 @@
+from typing import Any
+
+from pydantic import BaseModel, Field, field_validator
+
+from .schema import ModbusSchema
+from .status import ModbusStatus
+
+
+class ModbusWait(BaseModel):
+  """Modbus parameter model"""
+
+  status: ModbusStatus = Field(
+    ...,
+    description='Status of the Modbus command',
+  )
+
+  structure: ModbusSchema = Field(
+    ...,
+    description='Modbus structure schema',
+  )
+
+  port_id: int = Field(
+    ...,
+    description='Port ID for the Modbus command',
+  )
+
+  @field_validator('port_id', mode='before')
+  def validate_port_id(cls, value: Any) -> int:
+    """Validate and convert port_id to integer."""
+    if isinstance(value, int):
+      return value
+
+    if isinstance(value, str):
+      try:
+        return int(value)
+      except ValueError as e:
+        raise ValueError(f'Invalid Modbus port_id value: {value}') from e
+
+    raise ValueError(f'Invalid Modbus port_id type: {type(value)}')
+
+  split_each: int = Field(
+    ...,
+    description='Number of bytes to split each Modbus parameter',
+  )
+
+  @field_validator('split_each', mode='before')
+  def validate_split_each(cls, value: Any) -> int:
+    """Validate and convert split_each to integer."""
+    if isinstance(value, int):
+      return value
+
+    if isinstance(value, str):
+      try:
+        return int(value)
+      except ValueError as e:
+        raise ValueError(f'Invalid Modbus split_each value: {value}') from e
+
+    raise ValueError(f'Invalid Modbus split_each type: {type(value)}')
+
+  data_length: int = Field(
+    ...,
+    description='Length of data for the Modbus parameter, from Hexadecimal representation',
+  )
+
+  @field_validator('data_length', mode='before')
+  def validate_data_length(cls, value: Any) -> int:
+    """Validate and convert data_length to integer."""
+    if isinstance(value, int):
+      return value
+
+    if isinstance(value, str):
+      try:
+        return int(value, 16)  # Convert from hexadecimal string to integer
+      except ValueError as e:
+        raise ValueError(f'Invalid Modbus data_length value: {value}') from e
+
+    raise ValueError(f'Invalid Modbus data_length type: {type(value)}')
+
+  data_address: int = Field(
+    ...,
+    description='Address of the Modbus parameter, from Hexadecimal representation',
+  )
+
+  @field_validator('data_address', mode='before')
+  def validate_data_address(cls, value: Any) -> int:
+    """Validate and convert data_address to integer."""
+    if isinstance(value, int):
+      return value
+
+    if isinstance(value, str):
+      try:
+        return int(value, 16)  # Convert from hexadecimal string to integer
+      except ValueError as e:
+        raise ValueError(f'Invalid Modbus data_address value: {value}') from e
+
+    raise ValueError(f'Invalid Modbus data_address type: {type(value)}')
+
+  function_code: int = Field(
+    ...,
+    description='Function code for the Modbus parameter',
+  )
+
+  @field_validator('function_code', mode='before')
+  def validate_function_code(cls, value: Any) -> int:
+    """Validate and convert function_code to integer."""
+    if isinstance(value, int):
+      return value
+
+    if isinstance(value, str):
+      try:
+        return int(value, 16)  # Convert from hexadecimal string to integer
+      except ValueError as e:
+        raise ValueError(f'Invalid Modbus function_code value: {value}') from e
+
+    raise ValueError(f'Invalid Modbus function_code type: {type(value)}')
+
+  controller_address: int = Field(
+    ...,
+    description='Controller address for the Modbus parameter',
+  )
+
+  @field_validator('controller_address', mode='before')
+  def validate_controller_address(cls, value: Any) -> int:
+    """Validate and convert controller_address to integer."""
+    if isinstance(value, int):
+      return value
+
+    if isinstance(value, str):
+      try:
+        return int(value, 16)  # Convert from hexadecimal string to integer
+      except ValueError as e:
+        raise ValueError(f'Invalid Modbus controller_address value: {value}') from e
+
+    raise ValueError(f'Invalid Modbus controller_address type: {type(value)}')

layrz_sdk/entities/outbound_service.py

@@ -1,10 +1,10 @@
-"""Service entity"""
-
-from pydantic import BaseModel, Field
-
-
-class OutboundService(BaseModel):
-  """Outbound service definition"""
-
-  pk: int = Field(description='Service ID')
-  name: str = Field(description='Service name')
+"""Service entity"""
+
+from pydantic import BaseModel, Field
+
+
+class OutboundService(BaseModel):
+  """Outbound service definition"""
+
+  pk: int = Field(description='Service ID')
+  name: str = Field(description='Service name')

layrz_sdk/entities/position.py

@@ -1,116 +1,116 @@
-"""Position entity"""
-
-import sys
-from typing import Any, Optional
-
-from pydantic import BaseModel, Field, field_validator
-
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
-
-
-class Position(BaseModel):
-  """Geographic position definition"""
-
-  latitude: Optional[float] = Field(default=None, description='Defines the latitude of the position')
-  longitude: Optional[float] = Field(default=None, description='Defines the longitude of the position')
-  altitude: Optional[float] = Field(default=None, description='Defines the altitude of the position')
-  hdop: Optional[float] = Field(default=None, description='Defines the horizontal dilution of precision')
-  speed: Optional[float] = Field(default=None, description='Defines the speed of the position')
-  direction: Optional[float] = Field(default=None, description='Defines the direction of the position')
-  satellites: Optional[int] = Field(
-    default=None,
-    description='Defines the number of satellites used to calculate the position',
-  )
-
-  @field_validator('latitude', mode='before')
-  def _validate_latitude(cls: Self, value: Any) -> None | float:
-    """Validate latitude"""
-    if value is None:
-      return None
-
-    if not isinstance(value, (int, float)):
-      return None
-
-    if isinstance(value, int):
-      value = float(value)
-
-    if -90 <= value <= 90:
-      return value
-
-    return None
-
-  @field_validator('longitude', mode='before')
-  def _validate_longitude(cls: Self, value: Any) -> None | float:
-    """Validate longitude"""
-    if value is None:
-      return None
-
-    if not isinstance(value, (int, float)):
-      return None
-
-    if isinstance(value, int):
-      value = float(value)
-
-    if -180 <= value <= 180:
-      return value
-
-    return None
-
-  @field_validator('altitude', mode='before')
-  def _validate_altitude(cls: Self, value: Any) -> None | float:
-    """Validate altitude"""
-    if value is None:
-      return None
-
-    if not isinstance(value, (float, int)):
-      return None
-
-    return value
-
-  @field_validator('hdop', mode='before')
-  def _validate_hdop(cls: Self, value: Any) -> None | float:
-    """Validate hdop"""
-    if value is None:
-      return None
-
-    if not isinstance(value, (int, float)):
-      return None
-
-    if isinstance(value, int):
-      value = float(value)
-
-    return value
-
-  @field_validator('speed', mode='before')
-  def _validate_speed(cls: Self, value: Any) -> None | float:
-    """Validate speed"""
-    if value is None:
-      return None
-
-    if not isinstance(value, (float, int)):
-      return None
-
-    if isinstance(value, int):
-      value = float(value)
-
-    return abs(value)
-
-  @field_validator('direction', mode='before')
-  def _validate_direction(cls: Self, value: Any) -> None | float:
-    """Validate direction"""
-    if value is None:
-      return None
-
-    if not isinstance(value, (float, int)):
-      return None
-
-    if isinstance(value, int):
-      value = float(value)
-
-    if 0 <= value <= 360:
-      return value
-
-    return None
+"""Position entity"""
+
+import sys
+from typing import Any, Optional
+
+from pydantic import BaseModel, Field, field_validator
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class Position(BaseModel):
+  """Geographic position definition"""
+
+  latitude: Optional[float] = Field(default=None, description='Defines the latitude of the position')
+  longitude: Optional[float] = Field(default=None, description='Defines the longitude of the position')
+  altitude: Optional[float] = Field(default=None, description='Defines the altitude of the position')
+  hdop: Optional[float] = Field(default=None, description='Defines the horizontal dilution of precision')
+  speed: Optional[float] = Field(default=None, description='Defines the speed of the position')
+  direction: Optional[float] = Field(default=None, description='Defines the direction of the position')
+  satellites: Optional[int] = Field(
+    default=None,
+    description='Defines the number of satellites used to calculate the position',
+  )
+
+  @field_validator('latitude', mode='before')
+  def _validate_latitude(cls: Self, value: Any) -> None | float:
+    """Validate latitude"""
+    if value is None:
+      return None
+
+    if not isinstance(value, (int, float)):
+      return None
+
+    if isinstance(value, int):
+      value = float(value)
+
+    if -90 <= value <= 90:
+      return value
+
+    return None
+
+  @field_validator('longitude', mode='before')
+  def _validate_longitude(cls: Self, value: Any) -> None | float:
+    """Validate longitude"""
+    if value is None:
+      return None
+
+    if not isinstance(value, (int, float)):
+      return None
+
+    if isinstance(value, int):
+      value = float(value)
+
+    if -180 <= value <= 180:
+      return value
+
+    return None
+
+  @field_validator('altitude', mode='before')
+  def _validate_altitude(cls: Self, value: Any) -> None | float:
+    """Validate altitude"""
+    if value is None:
+      return None
+
+    if not isinstance(value, (float, int)):
+      return None
+
+    return value
+
+  @field_validator('hdop', mode='before')
+  def _validate_hdop(cls: Self, value: Any) -> None | float:
+    """Validate hdop"""
+    if value is None:
+      return None
+
+    if not isinstance(value, (int, float)):
+      return None
+
+    if isinstance(value, int):
+      value = float(value)
+
+    return value
+
+  @field_validator('speed', mode='before')
+  def _validate_speed(cls: Self, value: Any) -> None | float:
+    """Validate speed"""
+    if value is None:
+      return None
+
+    if not isinstance(value, (float, int)):
+      return None
+
+    if isinstance(value, int):
+      value = float(value)
+
+    return abs(value)
+
+  @field_validator('direction', mode='before')
+  def _validate_direction(cls: Self, value: Any) -> None | float:
+    """Validate direction"""
+    if value is None:
+      return None
+
+    if not isinstance(value, (float, int)):
+      return None
+
+    if isinstance(value, int):
+      value = float(value)
+
+    if 0 <= value <= 360:
+      return value
+
+    return None

layrz_sdk/entities/presence_type.py

@@ -1,16 +1,16 @@
-from enum import Enum
-
-
-class PresenceType(Enum):
-  """Presence type enum"""
-
-  ENTRANCE = 'ENTRANCE'
-  EXIT = 'EXIT'
-
-  def __str__(self) -> str:
-    """Readable property"""
-    return self.name
-
-  def __repr__(self) -> str:
-    """Readable property"""
-    return f'PresenceType.{self.name}'
+from enum import Enum
+
+
+class PresenceType(Enum):
+  """Presence type enum"""
+
+  ENTRANCE = 'ENTRANCE'
+  EXIT = 'EXIT'
+
+  def __str__(self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self) -> str:
+    """Readable property"""
+    return f'PresenceType.{self.name}'