ul-data-logger-api-sdk 3.3.4__tar.gz → 3.4.0__tar.gz

{ul_data_logger_api_sdk-3.3.4 → ul_data_logger_api_sdk-3.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: ul-data-logger-api-sdk
-Version: 3.3.4
+Version: 3.4.0
 Summary: Data logger API sdk
 Author: Unic-lab
 License-Expression: MIT

{ul_data_logger_api_sdk-3.3.4 → ul_data_logger_api_sdk-3.4.0}/data_logger_api_sdk.py

@@ -25,7 +25,7 @@ from data_logger_api_sdk.types.api_base_stations import (
     ApiBaseStationSystemLogResponse,
     ApiBaseStationSystemLogsListResult,
 )
-from data_logger_api_sdk.types.api_bs_device_links import ApiBsDeviceLinkResponse, ApiBsDeviceLinksListResult
+from data_logger_api_sdk.types.api_bs_device_links import ApiBsDeviceLinkResponse
 from data_logger_api_sdk.types.api_bs_traffic_stats import ApiBsTrafficStatsResponse, ApiDeviceTrafficStatsQuery
 from data_logger_api_sdk.types.api_uplink_signal import (
     ApiDeviceUplinkSignalLatestResponse,
@@ -180,7 +180,6 @@ class DataLoggerApiSdk:
         serial_number: int | None = None,
         log_stat_days: int = 0,
     ) -> ApiBaseStationsListResult:
-        """GET /base-stations — список базовых станций Data Logger."""
         query: Dict[str, Any] = {
             "limit": limit,
             "offset": offset,
@@ -202,12 +201,7 @@ class DataLoggerApiSdk:
         offset: int = 0,
         macs: List[int] | None = None,
     ) -> ApiDeviceUplinkSignalsListResult:
-        """GET /uplink-signal-latest — последний uplink-сигнал каждого мака.
-
-        Последний по метеру, группировка по маку (один мак = одна строка);
-        macs — рантайм-фильтр по конкретным устройствам. bs_id —
-        идентификатор БС Data Logger (= external_bs_id потребителя).
-        """
+        """Последний uplink-сигнал каждого мака (один мак — одна строка)."""
         query: Dict[str, Any] = {"limit": limit, "offset": offset}
         if macs:
             query["mac"] = macs
@@ -219,28 +213,27 @@ class DataLoggerApiSdk:
         )
         return ApiDeviceUplinkSignalsListResult(items=items, total_count=total_count)
 
-    def get_bs_device_links(
+    def get_bs_device_links_for_bs(
         self,
+        bs_id: UUID,
         start_at: datetime,
         end_at: datetime | None = None,
-        limit: int = 500,
-        offset: int = 0,
-    ) -> ApiBsDeviceLinksListResult:
-        """GET /bs-device-links — связи «мак ↔ БС» за период («когда-либо» при start_at из далёкого прошлого).
+    ) -> List[ApiBsDeviceLinkResponse]:
+        """GET /bs-device-links?bs_id=… — связи «мак ↔ БС» одной БС за окно (~90 дней ночного синка).
 
-        Один запрос по журналу device_log (дистинкт по паре мак+БС) вместо
-        обхода всех БС; для ночного синка слоя «Объекты и устройства».
+        Ответ капится сервером (DL_BS_LINKS_PER_BS_LIMIT, при переполнении
+        дробится окно); дедуп между под-окнами — на потребителе.
         """
-        query: Dict[str, Any] = {"start_at": start_at.isoformat(), "limit": limit, "offset": offset}
+        query: Dict[str, Any] = {"bs_id": str(bs_id), "start_at": start_at.isoformat()}
         if end_at is not None:
             query["end_at"] = end_at.isoformat()
-        items, total_count = self._request_list_payload_once(
-            ApiMethod.GET,
-            "/bs-device-links",
-            List[ApiBsDeviceLinkResponse],  # type: ignore
-            query,
-        )
-        return ApiBsDeviceLinksListResult(items=items, total_count=total_count)
+        response = self._api.request(
+            method=ApiMethod.GET,
+            path="/bs-device-links",
+            json=None,
+            q=query,
+        ).typed(List[ApiBsDeviceLinkResponse]).check()
+        return response.payload
 
     def get_base_station(
         self,
@@ -248,11 +241,7 @@ class DataLoggerApiSdk:
         log_stat_days: int = 0,
         exclude_log_types: List[str] | None = None,
     ) -> ApiBaseStationDetailResponse:
-        """GET /base-stations/<uuid> — карточка базовой станции Data Logger.
-
-        exclude_log_types исключает типы из logs_stat (например, ['heartbit']);
-        без него счётчики включают служебные heartbeat-логи.
-        """
+        """exclude_log_types исключает типы из счётчиков logs_stat (например, ['heartbit'])."""
         query: Dict[str, Any] = {"log_stat_days": log_stat_days}
         if exclude_log_types:
             query["exclude_log_types"] = exclude_log_types
@@ -273,11 +262,6 @@ class DataLoggerApiSdk:
         exclude_log_types: List[str] | None = None,
         sort: str | None = None,
     ) -> ApiBaseStationLogsListResult:
-        """GET /base-stations/<uuid>/logs — журнал логов базовой станции.
-
-        exclude_log_types передаётся стандартным filter-параметром
-        (например, ['heartbit'] прячет служебные heartbeat-логи).
-        """
         query: Dict[str, Any] = {"limit": limit, "offset": offset}
         if start_at is not None:
             query["start_at"] = start_at.isoformat()
@@ -300,7 +284,6 @@ class DataLoggerApiSdk:
         base_station_id: UUID,
         log_id: UUID,
     ) -> ApiBaseStationLogDetailResponse:
-        """GET /base-stations/<uuid>/logs/<uuid> — конкретный лог БС с сырым JSON пакета."""
         return self._request_payload_once(
             ApiMethod.GET,
             f"/base-stations/{base_station_id}/logs/{log_id}",
@@ -315,7 +298,6 @@ class DataLoggerApiSdk:
         limit: int = 100,
         offset: int = 0,
     ) -> ApiBaseStationSystemLogsListResult:
-        """GET /base-stations/<uuid>/system-logs — журнал системных логов базовой станции."""
         query: Dict[str, Any] = {"limit": limit, "offset": offset}
         if start_at is not None:
             query["start_at"] = start_at.isoformat()
@@ -335,10 +317,6 @@ class DataLoggerApiSdk:
         day: date,
         exclude_log_types: List[str] | None = None,
     ) -> ApiBaseStationLogsStatResponse:
-        """GET /base-stations/<uuid>/logs-stat — статистика логов базовой станции за сутки.
-
-        exclude_log_types исключает типы из поминутных счётчиков (['heartbit'] прячет heartbeat).
-        """
         query: Dict[str, Any] = {"day": day.isoformat()}
         if exclude_log_types:
             query["exclude_log_types"] = exclude_log_types
@@ -355,7 +333,6 @@ class DataLoggerApiSdk:
         start_at: datetime,
         end_at: datetime | None = None,
     ) -> ApiBaseStationDeviceLogsStatResponse:
-        """GET /base-stations/<uuid>/device-logs-stat — число логов устройств БС по дням."""
         query: Dict[str, Any] = {"start_at": start_at.isoformat()}
         if end_at is not None:
             query["end_at"] = end_at.isoformat()
@@ -372,7 +349,6 @@ class DataLoggerApiSdk:
         start_at: datetime,
         end_at: datetime | None = None,
     ) -> ApiBaseStationLogsStatForIntervalsResponse:
-        """GET /base-stations/<uuid>/logs-stat-for-intervals — метки времени логов за интервал."""
         query: Dict[str, Any] = {"start_at": start_at.isoformat()}
         if end_at is not None:
             query["end_at"] = end_at.isoformat()
@@ -391,7 +367,6 @@ class DataLoggerApiSdk:
         limit: int = 100,
         offset: int = 0,
     ) -> ApiBaseStationDevicesResponse:
-        """GET /base-stations/<uuid>/devices — устройства, работающие через базовую станцию."""
         query: Dict[str, Any] = {"start_at": start_at.isoformat(), "limit": limit, "offset": offset}
         if end_at is not None:
             query["end_at"] = end_at.isoformat()
@@ -410,7 +385,6 @@ class DataLoggerApiSdk:
         limit: int = 100,
         offset: int = 0,
     ) -> ApiBaseStationDeviceLogsResponse:
-        """GET /base-stations/<uuid>/device-logs — логи устройств базовой станции."""
         query: Dict[str, Any] = {"start_at": start_at.isoformat(), "limit": limit, "offset": offset}
         if end_at is not None:
             query["end_at"] = end_at.isoformat()

{ul_data_logger_api_sdk-3.3.4 → ul_data_logger_api_sdk-3.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "ul-data-logger-api-sdk"
-version = "3.3.4"
+version = "3.4.0"
 description = "Data logger API sdk"
 license = "MIT"
 requires-python = ">=3.14"

{ul_data_logger_api_sdk-3.3.4 → ul_data_logger_api_sdk-3.4.0}/types/api_base_stations.py

@@ -9,29 +9,21 @@ BS__LOG_TYPE__HEARTBIT = "heartbit"
 
 
 class ApiBaseStationsListResult(NamedTuple):
-    """Результат спискового вызова BS-endpoint Data Logger: страница элементов и total_count."""
-
     items: List["ApiBaseStationResponse"]
     total_count: int
 
 
 class ApiBaseStationLogsListResult(NamedTuple):
-    """Результат вызова GET /base-stations/<uuid>/logs."""
-
     items: List["ApiBaseStationLogResponse"]
     total_count: int
 
 
 class ApiBaseStationSystemLogsListResult(NamedTuple):
-    """Результат вызова GET /base-stations/<uuid>/system-logs."""
-
     items: List["ApiBaseStationSystemLogResponse"]
     total_count: int
 
 
 class ApiBaseStationResponse(JsonApiResponsePayload):
-    """Элемент ответа GET /base-stations (BsListShortResponse на стороне Data Logger)."""
-
     id: UUID4
     date_created: datetime
     date_modified: datetime
@@ -55,8 +47,6 @@ class ApiBaseStationResponse(JsonApiResponsePayload):
 
 
 class ApiBaseStationDetailResponse(ApiBaseStationResponse):
-    """Ответ GET /base-stations/<uuid> (BsResponse на стороне Data Logger)."""
-
     latest_sdr_config: Dict[str, Any] | None = None
     device_counts: List[Tuple[datetime, int]] | None = None
     system_logs_stat: List[Tuple[datetime, int]] | None = None
@@ -65,12 +55,7 @@ class ApiBaseStationDetailResponse(ApiBaseStationResponse):
 
 
 class ApiBaseStationLogResponse(JsonApiResponsePayload):
-    """Элемент ответа GET /base-stations/<uuid>/logs (ApiBsLogsResponse на стороне Data Logger).
-
-    rssi/snr/protocol_type/packet_type_name/network_sys_type/error_* обогащаются
-    из сырого документа пакета (блок meta.bs_http / meta.nbfi_bs0); null, если
-    документа нет или в нём нет этих полей.
-    """
+    """Лог БС; rssi/snr и поля пакета (protocol_type, error_*) — из сырого документа, null при его отсутствии."""
 
     id: UUID4
     date_created: datetime
@@ -98,14 +83,10 @@ class ApiBaseStationLogResponse(JsonApiResponsePayload):
 
 
 class ApiBaseStationLogDetailResponse(ApiBaseStationLogResponse):
-    """Ответ GET /base-stations/<uuid>/logs/<uuid> — лог с сырым JSON пакета (ApiBsLogDetailResponse в DL)."""
-
     data: Dict[str, Any] | None = None
 
 
 class ApiBaseStationSystemLogResponse(JsonApiResponsePayload):
-    """Элемент ответа GET /base-stations/<uuid>/system-logs (ApiBsSystemLogsResponse)."""
-
     id: UUID4
     date_created: datetime
 
@@ -118,26 +99,22 @@ class ApiBaseStationSystemLogResponse(JsonApiResponsePayload):
 
 
 class ApiBaseStationLogsStatResponse(JsonApiResponsePayload):
-    """Ответ GET /base-stations/<uuid>/logs-stat (ApiBsLogsStatResponse)."""
-
     stats: List[Tuple[datetime, int]]
 
 
 class ApiBaseStationLogsStatForIntervalsResponse(JsonApiResponsePayload):
-    """Ответ GET /base-stations/<uuid>/logs-stat-for-intervals (ApiBsLogsStatForIntervalsGraphResponse)."""
+    """Метки времени логов за интервал."""
 
     stats: List[datetime]
 
 
 class ApiBaseStationDeviceLogsStatResponse(JsonApiResponsePayload):
-    """Ответ GET /base-stations/<uuid>/device-logs-stat: число логов устройств по дням."""
+    """Число логов устройств БС по дням."""
 
     stats: List[Tuple[date, int]]
 
 
 class ApiBaseStationDeviceResponse(JsonApiResponsePayload):
-    """Элемент devices ответа GET /base-stations/<uuid>/devices (ApiDeviceResponse без вложенной БС)."""
-
     id: UUID4
     date_created: datetime
     date_modified: datetime
@@ -163,15 +140,11 @@ class ApiBaseStationDeviceResponse(JsonApiResponsePayload):
 
 
 class ApiBaseStationDevicesResponse(JsonApiResponsePayload):
-    """Ответ GET /base-stations/<uuid>/devices (ApiBsDevicesResponse)."""
-
     devices: List[ApiBaseStationDeviceResponse]
     device_count: int
 
 
 class ApiBaseStationDeviceLogResponse(JsonApiResponsePayload):
-    """Элемент device_logs ответа GET /base-stations/<uuid>/device-logs (ApiDeviceLogsResponse)."""
-
     id: UUID4
     date_created: datetime
 
@@ -202,8 +175,6 @@ class ApiBaseStationDeviceLogResponse(JsonApiResponsePayload):
 
 
 class ApiBaseStationDeviceLogsResponse(JsonApiResponsePayload):
-    """Ответ GET /base-stations/<uuid>/device-logs (ApiBsDeviceLogsResponse)."""
-
     device_logs: List[ApiBaseStationDeviceLogResponse]
     device_logs_count: int
     device_count: int

ul_data_logger_api_sdk-3.4.0/types/api_bs_device_links.py

@@ -0,0 +1,15 @@
+from pydantic import UUID4
+from ul_api_utils.api_resource.api_response import JsonApiResponsePayload
+
+
+class ApiBsDeviceLinkResponse(JsonApiResponsePayload):
+    """Связь «мак ↔ БС» за период: элемент ответа GET /bs-device-links.
+
+    bs_id — идентификатор БС Data Logger (у потребителя unified API —
+    external_bs_id); bs_identifier — серийный номер БС.
+    """
+
+    device_network_mac: int
+    bs_id: UUID4
+    device_id: UUID4
+    bs_identifier: str

ul_data_logger_api_sdk-3.4.0/types/api_uplink_signal.py

@@ -0,0 +1,22 @@
+from datetime import datetime
+from typing import List, NamedTuple
+
+from pydantic import UUID4
+from ul_api_utils.api_resource.api_response import JsonApiResponsePayload
+
+
+class ApiDeviceUplinkSignalLatestResponse(JsonApiResponsePayload):
+    """Последний uplink-сигнал мака; bs_identifier — серийный номер БС, packet_date — время последнего пакета."""
+
+    mac: int
+    device_id: UUID4
+    bs_id: UUID4 | None = None
+    bs_identifier: str | None = None
+    rssi: int | None = None
+    snr: int | None = None
+    packet_date: datetime | None = None
+
+
+class ApiDeviceUplinkSignalsListResult(NamedTuple):
+    items: List[ApiDeviceUplinkSignalLatestResponse]
+    total_count: int

ul_data_logger_api_sdk-3.3.4/types/api_bs_device_links.py

@@ -1,25 +0,0 @@
-from typing import List, NamedTuple
-
-from pydantic import UUID4
-from ul_api_utils.api_resource.api_response import JsonApiResponsePayload
-
-
-class ApiBsDeviceLinkResponse(JsonApiResponsePayload):
-    """Связь «мак ↔ БС» за период: элемент ответа GET /bs-device-links.
-
-    Пара существует, если БС когда-либо получала пакет устройства в
-    запрошенном окне (дистинкт по журналу device_log). bs_id — идентификатор
-    БС Data Logger (у потребителя unified API это external_bs_id);
-    bs_identifier — её серийный номер.
-    """
-
-    device_network_mac: int
-    bs_id: UUID4
-    bs_identifier: str
-
-
-class ApiBsDeviceLinksListResult(NamedTuple):
-    """Результат спискового вызова: страница элементов и total_count."""
-
-    items: List[ApiBsDeviceLinkResponse]
-    total_count: int

ul_data_logger_api_sdk-3.3.4/types/api_uplink_signal.py

@@ -1,29 +0,0 @@
-from datetime import datetime
-from typing import List, NamedTuple
-
-from pydantic import UUID4
-from ul_api_utils.api_resource.api_response import JsonApiResponsePayload
-
-
-class ApiDeviceUplinkSignalLatestResponse(JsonApiResponsePayload):
-    """Последний uplink-сигнал мака: элемент ответа GET /uplink-signal-latest.
-
-    bs_id — идентификатор базовой станции Data Logger (у потребителя unified
-    API это external_bs_id, маппинг по серийнику не нужен); bs_identifier —
-    серийный номер БС. packet_date — время последнего пакета устройства.
-    """
-
-    mac: int
-    device_id: UUID4
-    bs_id: UUID4 | None = None
-    bs_identifier: str | None = None
-    rssi: int | None = None
-    snr: int | None = None
-    packet_date: datetime | None = None
-
-
-class ApiDeviceUplinkSignalsListResult(NamedTuple):
-    """Результат спискового вызова: страница элементов и total_count."""
-
-    items: List[ApiDeviceUplinkSignalLatestResponse]
-    total_count: int