__init__.py

# The MIT License (MIT)
# Copyright (c) 2023 Edgaras Janušauskas and Inovatorius MB (www.fildz.com)

################################################################################
# FILDZ CYBEROS CYBERWARE API
#
# All the hardware-related setup for the cyberware such as its name, id, mac, etc. Every cyberware has an integrated
# power button that is used for pairing. Additionally, every cyberware can come with one (or more) device such as a
# sensor, button, display, accelerometer, etc.

# TODO:
#  1. Cyberware status monitor e.g. "OK", "CONNECTING TO AP", "WRONG PASSWORD", etc.

import network
import ubinascii
from machine import unique_id, Pin, PWM


class CYBERWARE:
    def __init__(self):
        self._fullname = 'GENERIC CYBERWARE'
        self._type = 'CYBERWARE'
        self._id = ubinascii.hexlify(unique_id()[:3]).upper()  # ESP8266/ESP8285 returns e.g. b'\x0f\x88\x9a\x00'
        self._version = 'CYBERWARE_VERSION'
        self._model = 'CYBERWARE_MODEL'
        self._status = 'CYBERWARE_STATUS'
        self._name = '%s-%s' % (self._type, self._id.decode())
        self._mac_private = network.WLAN(network.STA_IF).config('mac')
        self._mac_private_str = ubinascii.hexlify(self._mac_private, ':').decode().upper()
        # We must use bytearray here instead of bytes.
        # See: https://github.com/micropython/micropython/issues/11357
        # self._mac_public = b'\x9e\x9c\x1f\x00\x00\x00'
        self._mac_public = bytearray(b'\x9e\x9c\x1f\x00\x00\x00')
        self._mac_public_str = '9E:9C:1F:00:00:00'

        # Cyberware devices and sensors go here.
        #
        # Integrated power button on pin 13.
        from fildz_button import Button
        self._power_button = Button(Pin(13, Pin.OUT))

        # Integrated buzzer on pin 12.
        from fildz_buzzer import Buzzer
        self._buzzer = Buzzer(PWM(Pin(12), freq=100, duty=0))

        # Integrated WS2812 (NeoPixel) on pin 14.
        from fildz_neopixel import NeoPixel
        self._pixel = NeoPixel(Pin(14, Pin.OUT), 1)

    ################################################################################
    # Properties
    #
    # Name e.g., "BUTTON-02AD9A".
    @property
    def name(self):
        return self._name

    # Fullname displays the entire name of the cyberware e.g., "OLED DISPLAY 0.96” 128x64 REV 1.0".
    @property
    def fullname(self):
        return self._fullname

    # Defines the cyberware type e.g., "BUTTON".
    @property
    def type(self):
        return self._type

    # Unique ID of the cyberware e.g., b'OF889A'.
    @property
    def id(self):
        return self._id

    # Version of the cyberware e.g., "1.0".
    @property
    def version(self):
        return self._version

    # Model of the cyberware e.g., "FCW-12345".
    @property
    def model(self):
        return self._model

    # Display real-time status of the cyberware e.g., "OK", "PAIRING".
    # Status is displayed when the user is connected to cyberware via the web interface.
    @property
    def status(self):
        return self._status

    @status.setter
    def status(self, value):
        self._status = value

    # Private MAC address e.g., b'\x9c\x9c\x1f\xXX\xXX\xXX'.
    # This MAC address is set on the STA interface and is used for communication between paired cyberwares.
    @property
    def mac_private(self):
        return self._mac_private

    # Private MAC address as string e.g., "9C:9C:1F:XX:XX:XX".
    @property
    def mac_private_str(self):
        return self._mac_private_str

    # Public MAC address bytearray(b'\x9e\x9c\x1f\x00\x00\x00').
    # This MAC address is hardcoded to every cyberware and set on the AP interface.
    # It is used for just one thing - pairing.
    # When cyberware starts to send pairing requests, it is sending them to a public MAC address.
    @property
    def mac_public(self):
        return self._mac_public

    # Public MAC address as string "9E:9C:1F:00:00:00".
    @property
    def mac_public_str(self):
        return self._mac_public_str

    # Single power button that is integrated into every cyberware.
    # Primarily used for pairing and to enable/disable AP.
    @property
    def power_button(self):
        return self._power_button

    # Single buzzer that is integrated into every cyberware.
    # Primarily used to notify user when cyberware is powered on, on successful pairing etc.
    @property
    def buzzer(self):
        return self._buzzer

    # Single WS2812 that is integrated into every cyberware.
    # Primarily used to identify the module AP via blinking colors.
    @property
    def pixel(self):
        return self._pixel