api.v1.subnet¶
- api.v1.subnet.add_note(mac: str, request: NoteRequest, subnet_service: SubnetService = Depends(get_subnet_service), translations: Translations = Depends(translations_dependency))[source]¶
Добавляет заметку для устройства по MAC-адресу.
Привязывает заметку к устройству, идентифицируемому по MAC-адресу.
- Args:
mac (str): MAC-адрес устройства. request (NoteRequest): Объект с полем “note” для текста заметки. subnet_service: Сервис сканирования подсети. translations: Объект переводов для текущего языка.
- Returns:
dict: Словарь с сообщением об успешном добавлении заметки.
- Raises:
- HTTPException: Если устройство не найдено (status_code=404), заметка уже
существует (status_code=400), или произошла внутренняя ошибка (status_code=500).
- api.v1.subnet.add_wifi_note(ssid: str, request: NoteRequest, translations: Translations = Depends(translations_dependency))[source]¶
Добавляет заметку для сети Wi-Fi по SSID.
Привязывает заметку к Wi-Fi сети, идентифицируемой по SSID.
- Args:
ssid (str): Идентификатор Wi-Fi сети. request (NoteRequest): Объект с полем “note” для текста заметки. translations: Объект переводов для текущего языка.
- Returns:
dict: Словарь с сообщением об успешном добавлении заметки.
- Raises:
- HTTPException: Если сеть не найдена (status_code=404), заметка уже
существует (status_code=400), или произошла внутренняя ошибка (status_code=500).
- api.v1.subnet.connect_to_wifi(request: WifiConnectRequest, translations: Translations = Depends(translations_dependency))[source]¶
Подключается к Wi-Fi сети по SSID и паролю.
Выполняет подключение к указанной Wi-Fi сети с использованием предоставленных учетных данных.
- Args:
request (WifiConnectRequest): Объект с полями “ssid” и “password”. translations: Объект переводов для текущего языка.
- Returns:
dict: Словарь с сообщением об успешном подключении.
- Raises:
HTTPException: Если подключение не удалось (status_code=400).
- api.v1.subnet.delete_note(mac: str, subnet_service: SubnetService = Depends(get_subnet_service), translations: Translations = Depends(translations_dependency))[source]¶
Удаляет заметку для устройства по MAC-адресу.
Удаляет привязанную заметку для указанного устройства.
- Args:
mac (str): MAC-адрес устройства. subnet_service: Сервис сканирования подсети. translations: Объект переводов для текущего языка.
- Returns:
dict: Словарь с сообщением об успешном удалении заметки.
- Raises:
- HTTPException: Если устройство не найдено (status_code=404), заметка не
существует (status_code=400), или произошла внутренняя ошибка (status_code=500).
- api.v1.subnet.delete_wifi_note(ssid: str, translations: Translations = Depends(translations_dependency))[source]¶
Удаляет заметку для сети Wi-Fi по SSID.
Удаляет привязанную заметку для указанной Wi-Fi сети.
- Args:
ssid (str): Идентификатор Wi-Fi сети. translations: Объект переводов для текущего языка.
- Returns:
dict: Словарь с сообщением об успешном удалении заметки.
- Raises:
- HTTPException: Если сеть не найдена (status_code=404), заметка не
существует (status_code=400), или произошла внутренняя ошибка (status_code=500).
- api.v1.subnet.disconnect_from_wifi(request: WifiDisconnectRequest, translations: Translations = Depends(translations_dependency))[source]¶
Отключается от Wi-Fi сети по указанному SSID.
Выполняет отключение от указанной Wi-Fi сети.
- Args:
request (WifiDisconnectRequest): Объект с полем “ssid”. translations: Объект переводов для текущего языка.
- Returns:
dict: Словарь с сообщением об успешном отключении.
- Raises:
HTTPException: Если отключение не удалось (status_code=400).
- api.v1.subnet.get_wifi_status(translations: Translations = Depends(translations_dependency))[source]¶
Проверяет статус текущего подключения к Wi-Fi.
Возвращает информацию о текущем состоянии подключения и SSID, если подключение активно.
- Args:
translations: Объект переводов для текущего языка.
- Returns:
- dict: Словарь с ключами:
“status” (str): Состояние (“connected” или другое).
“ssid” (str, optional): SSID текущей сети, если подключено.
- Raises:
HTTPException: Если проверка статуса не удалась (status_code=400).
- api.v1.subnet.scan_subnet(request: SubnetScanRequest = Body(PydanticUndefined), subnet_service: SubnetService = Depends(get_subnet_service), translations: Translations = Depends(translations_dependency))[source]¶
Сканирует локальную подсеть и возвращает данные об устройствах.
Выполняет сканирование указанной подсети для обнаружения активных устройств.
- Args:
request (SubnetScanRequest): Объект с полем subnet. subnet_service: Сервис сканирования подсети. translations: Объект переводов для текущего языка.
- Returns:
SubnetScanResult: Объект с результатами сканирования (устройства и их данные).
- Raises:
HTTPException: Если произошла ошибка сканирования (status_code=500).
- api.v1.subnet.scan_wifi(timeout: int = 30, translations: Translations = Depends(translations_dependency))[source]¶
Сканирует Wi-Fi точки доступа и возвращает данные о них.
Выполняет сканирование доступных Wi-Fi сетей с указанным таймаутом.
- Args:
timeout (int, optional): Таймаут сканирования в секундах. По умолчанию 30. translations: Объект переводов для текущего языка.
- Returns:
WifiScanResult: Объект с результатами сканирования (список Wi-Fi сетей).
- Raises:
HTTPException: Если произошла ошибка сканирования Wi-Fi (status_code=500).
- api.v1.subnet.update_note(mac: str, request: NoteRequest, subnet_service: SubnetService = Depends(get_subnet_service), translations: Translations = Depends(translations_dependency))[source]¶
Обновляет заметку для устройства по MAC-адресу.
Изменяет существующую заметку, привязанную к устройству.
- Args:
mac (str): MAC-адрес устройства. request (NoteRequest): Объект с полем “note” для нового текста заметки. subnet_service: Сервис сканирования подсети. translations: Объект переводов для текущего языка.
- Returns:
dict: Словарь с сообщением об успешном обновлении заметки.
- Raises:
- HTTPException: Если устройство не найдено (status_code=404), заметка не
существует (status_code=400), или произошла внутренняя ошибка (status_code=500).
- api.v1.subnet.update_wifi_note(ssid: str, request: NoteRequest, translations: Translations = Depends(translations_dependency))[source]¶
Обновляет заметку для сети Wi-Fi по SSID.
Изменяет существующую заметку, привязанную к Wi-Fi сети.
- Args:
ssid (str): Идентификатор Wi-Fi сети. request (NoteRequest): Объект с полем “note” для нового текста заметки. translations: Объект переводов для текущего языка.
- Returns:
dict: Словарь с сообщением об успешном обновлении заметки.
- Raises:
- HTTPException: Если сеть не найдена (status_code=404), заметка не
существует (status_code=400), или произошла внутренняя ошибка (status_code=500).