Source code for pykiso.lib.connectors.cc_flasher_example

##########################################################################
# Copyright (c) 2010-2022 Robert Bosch GmbH
# This program and the accompanying materials are made available under the
# terms of the Eclipse Public License 2.0 which is available at
# http://www.eclipse.org/legal/epl-2.0.
#
# SPDX-License-Identifier: EPL-2.0
##########################################################################

"""
Fake Flasher Channel for testing
********************************

:module: cc_flasher_example

:synopsis: fake flasher implementation

.. warning: ONLY FOR TESTING PURPOSE!
"""

import logging

from pykiso import Flasher

log = logging.getLogger(__name__)


class FlasherExample(Flasher):
    """A Flasher adapter for testing purpose only."""

    def __init__(self, name: str, **kwargs) -> None:
        """Constructor.

        :param name: flasher's alias
        :param kwargs: named arguments
        """
        self.name = name

    def open(self) -> None:
        """Initialize the flasher."""
        log.internal_info("Initialize flasher")
        log.internal_info("Flasher ready!")

    def close(self) -> None:
        """Close flasher and free resources."""
        log.internal_info("Close flasher")
        log.internal_info("Free ressoucres!")

    def flash(self) -> None:
        """Fake a firmware update."""
        log.internal_info("flashing device")
        log.internal_info("flashing device successful")