"""Firmware update status model."""
# Copyright 2019 WolkAbout Technology s.r.o.
#
# 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.
from dataclasses import dataclass
from dataclasses import field
from enum import Enum
from enum import unique
from typing import Optional
[docs]@unique
class FirmwareUpdateState(Enum):
"""
Enumeration of available firmware update states.
:ivar ABORTED: Firmware installation aborted
:vartype ABORTED: str
:ivar COMPLETED: Firmware installation completed
:vartype COMPLETED: str
:ivar ERROR: Firmware installation error
:vartype ERROR: str
:ivar INSTALLATION: Firmware installation in progress
:vartype INSTALLATION: str
"""
INSTALLATION = "INSTALLATION"
COMPLETED = "COMPLETED"
ERROR = "ERROR"
ABORTED = "ABORTED"
[docs]@unique
class FirmwareUpdateErrorCode(Enum):
"""
Enumeration of possible firmware update errors.
:ivar DEVICE_NOT_PRESENT: Unable to pass firmware install command to device
:vartype DEVICE_NOT_PRESENT: int
:ivar FILE_NOT_PRESENT: Firmware file was not present at specified location
:vartype FILE_NOT_PRESENT: int
:ivar FILE_SYSTEM_ERROR: File system error occurred
:vartype FILE_SYSTEM_ERROR: int
:ivar INSTALLATION_FAILED: Firmware installation failed
:vartype INSTALLATION_FAILED: int
:ivar UNSPECIFIED_ERROR: Unspecified error occurred
:vartype UNSPECIFIED_ERROR: int
"""
UNSPECIFIED_ERROR = 0
FILE_NOT_PRESENT = 1
FILE_SYSTEM_ERROR = 2
INSTALLATION_FAILED = 3
DEVICE_NOT_PRESENT = 4
[docs]@dataclass
class FirmwareUpdateStatus:
"""
Holds information about current firmware update status.
:ivar status: Firmware update status
:vartype status: FirmwareUpdateState
:ivar error_code: Description of error that occured
:vartype error_code: Optional[FirmwareUpdateErrorCode]
"""
status: FirmwareUpdateState
error_code: Optional[FirmwareUpdateErrorCode] = field(default=None)