Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Solution #497

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 38 additions & 23 deletions app/iot/devices.py
Original file line number Diff line number Diff line change
@@ -1,64 +1,79 @@
import time
import asyncio

from .message import MessageType

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure that MessageType is correctly defined in the message.py file. If it's not defined or imported correctly, it will cause an error when trying to use message_type.name in the send_message methods.



TIME_TO_SLEEP = 0.5


# of course this code looks dumb, but imagine some real implementations of each method here
# of course this code looks dumb,
# but imagine some real implementations of each method here
class HueLightDevice:
def connect(self) -> None:
async def connect(self) -> None:
print("Connecting Hue Light.")
time.sleep(TIME_TO_SLEEP)
await asyncio.sleep(TIME_TO_SLEEP)
print("Hue Light connected.")

def disconnect(self) -> None:
async def disconnect(self) -> None:
print("Disconnecting Hue Light.")
time.sleep(TIME_TO_SLEEP)
await asyncio.sleep(TIME_TO_SLEEP)
print("Hue Light disconnected.")

def send_message(self, message_type: MessageType, data: str = "") -> None:
async def send_message(
self,
message_type: MessageType,
data: str = ""
) -> None:
print(
f"Hue Light handling message of type {message_type.name} with data [{data}]."
f"Hue Light handling message of type"
f"{message_type.name} with data [{data}]."
)
time.sleep(TIME_TO_SLEEP)
await asyncio.sleep(TIME_TO_SLEEP)
print("Hue Light received message.")


class SmartSpeakerDevice:
def connect(self) -> None:
async def connect(self) -> None:
print("Connecting to Smart Speaker.")
time.sleep(TIME_TO_SLEEP)
await asyncio.sleep(TIME_TO_SLEEP)
print("Smart Speaker connected.")

def disconnect(self) -> None:
async def disconnect(self) -> None:
print("Disconnecting Smart Speaker.")
time.sleep(TIME_TO_SLEEP)
await asyncio.sleep(TIME_TO_SLEEP)
print("Smart Speaker disconnected.")

def send_message(self, message_type: MessageType, data: str = "") -> None:
async def send_message(
self,
message_type: MessageType,
data: str = ""
) -> None:
print(
f"Smart Speaker handling message of type {message_type.name} with data [{data}]."
f"Smart Speaker handling message of type"
f"{message_type.name} with data [{data}]."
)
time.sleep(TIME_TO_SLEEP)
await asyncio.sleep(TIME_TO_SLEEP)
print("Smart Speaker received message.")


class SmartToiletDevice:
def connect(self) -> None:
async def connect(self) -> None:
print("Connecting to Smart Toilet.")
time.sleep(TIME_TO_SLEEP)
await asyncio.sleep(TIME_TO_SLEEP)
print("Smart Toilet connected.")

def disconnect(self) -> None:
async def disconnect(self) -> None:
print("Disconnecting Smart Toilet.")
time.sleep(TIME_TO_SLEEP)
await asyncio.sleep(TIME_TO_SLEEP)
print("Smart Toilet disconnected.")

def send_message(self, message_type: MessageType, data: str = "") -> None:
async def send_message(self,
message_type: MessageType,
data: str = ""
) -> None:
print(
f"Smart Toilet handling message of type {message_type.name} with data [{data}]."
f"Smart Toilet handling message of type"
f"{message_type.name} with data [{data}]."
)
time.sleep(TIME_TO_SLEEP)
await asyncio.sleep(TIME_TO_SLEEP)
print("Smart Toilet received message.")
35 changes: 20 additions & 15 deletions app/iot/service.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,48 +2,53 @@
import string
from typing import Protocol

from .message import Message, MessageType
from app.iot.message import Message, MessageType

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure that Message and MessageType are correctly defined in the message.py file. If they are not defined or imported correctly, it will cause errors when using them in the code.



def generate_id(length: int = 8) -> str:
return "".join(random.choices(string.ascii_uppercase, k=length))


# Protocol is very similar to ABC, but uses duck typing
# so devices should not inherit for it (if it walks like a duck, and quacks like a duck, it's a duck)
# so devices should not inherit for it (if it walks like a duck,
# and quacks like a duck, it's a duck)
class Device(Protocol):
def connect(self) -> None:
... # Ellipsis - similar to "pass", but sometimes has different meaning
async def connect(
self,
) -> None:
...
# Ellipsis - similar to "pass", but sometimes has different meaning

def disconnect(self) -> None:
async def disconnect(self) -> None:
...

def send_message(self, message_type: MessageType, data: str) -> None:
async def send_message(self, message_type: MessageType, data: str) -> None:
...


class IOTService:
def __init__(self) -> None:
self.devices: dict[str, Device] = {}

def register_device(self, device: Device) -> str:
device.connect()
async def register_device(self, device: Device) -> str:
await device.connect()
device_id = generate_id()
self.devices[device_id] = device
return device_id

def unregister_device(self, device_id: str) -> None:
self.devices[device_id].disconnect()
async def unregister_device(self, device_id: str) -> None:
await self.devices[device_id].disconnect()
del self.devices[device_id]

def get_device(self, device_id: str) -> Device:
return self.devices[device_id]

def run_program(self, program: list[Message]) -> None:
async def run_program(self, program: list[Message]) -> None:
print("=====RUNNING PROGRAM======")
for msg in program:
self.send_msg(msg)
await program

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The run_program method currently attempts to await a list, which is not valid. You should iterate over the program list and await each Message individually if they are asynchronous operations.

Comment on lines +46 to +48

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The run_program method attempts to await a list, which is not valid. You should iterate over the program list and await each Message individually if they are asynchronous operations.

print("=====END OF PROGRAM======")

def send_msg(self, msg: Message) -> None:
self.devices[msg.device_id].send_message(msg.msg_type, msg.data)
async def send_msg(
self, device_id: str, msg_type: MessageType, data: str = ""
) -> None:
await self.devices[device_id].send_message(msg_type, data)
63 changes: 40 additions & 23 deletions app/main.py
Original file line number Diff line number Diff line change
@@ -1,44 +1,61 @@
import asyncio
import time
from typing import Any, Awaitable

from iot.devices import HueLightDevice, SmartSpeakerDevice, SmartToiletDevice
from iot.message import Message, MessageType
from iot.message import MessageType
from iot.service import IOTService


def main() -> None:
async def run_sequence(*functions: Awaitable[Any]) -> None:
for function in functions:
await function


async def run_parallel(*functions: Awaitable[Any]) -> None:
await asyncio.gather(*functions)


async def main() -> None:
# create an IOT service
service = IOTService()

# create and register a few devices
hue_light = HueLightDevice()
speaker = SmartSpeakerDevice()
toilet = SmartToiletDevice()
hue_light_id = service.register_device(hue_light)
speaker_id = service.register_device(speaker)
toilet_id = service.register_device(toilet)
hue_light_id, speaker_id, toilet_id = await asyncio.gather(
service.register_device(HueLightDevice()),
service.register_device(SmartSpeakerDevice()),
service.register_device(SmartToiletDevice()),
)

# create a few programs
wake_up_program = [
Message(hue_light_id, MessageType.SWITCH_ON),
Message(speaker_id, MessageType.SWITCH_ON),
Message(speaker_id, MessageType.PLAY_SONG, "Rick Astley - Never Gonna Give You Up"),
]

sleep_program = [
Message(hue_light_id, MessageType.SWITCH_OFF),
Message(speaker_id, MessageType.SWITCH_OFF),
Message(toilet_id, MessageType.FLUSH),
Message(toilet_id, MessageType.CLEAN),
]
wake_up_program = run_sequence(
run_parallel(
service.send_msg(hue_light_id, MessageType.SWITCH_ON),
service.send_msg(speaker_id, MessageType.SWITCH_ON),
),
service.send_msg(
speaker_id,
MessageType.PLAY_SONG,
"Rick Astley - Never Gonna Give You Up"
),
)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The run_sequence function returns a coroutine, which should be awaited. Ensure that when you call run_sequence, you await its result if you intend to execute it immediately.

Comment on lines +31 to +41

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The run_sequence function returns a coroutine and should be awaited to execute it immediately. Ensure that wake_up_program is awaited.


sleep_program = run_sequence(
run_parallel(
service.send_msg(hue_light_id, MessageType.SWITCH_OFF),
service.send_msg(speaker_id, MessageType.SWITCH_OFF),
),
service.send_msg(toilet_id, MessageType.FLUSH),
service.send_msg(toilet_id, MessageType.CLEAN),
)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similarly, ensure that the sleep_program coroutine is awaited if you intend to execute it immediately.

Comment on lines +43 to +50

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The run_sequence function returns a coroutine and should be awaited to execute it immediately. Ensure that sleep_program is awaited.


# run the programs
service.run_program(wake_up_program)
service.run_program(sleep_program)
await service.run_program(run_parallel(wake_up_program, sleep_program))

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The run_program method in IOTService is designed to take a list of Message objects, but here it's being passed the result of run_parallel, which is a coroutine. You need to adjust the run_program method to handle coroutines or change the way programs are defined and executed.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The run_program method is passed a coroutine from run_parallel, which is not handled correctly. You need to adjust the method to handle coroutines or change how programs are defined and executed.



if __name__ == "__main__":
start = time.perf_counter()
main()
asyncio.run(main())
end = time.perf_counter()

print("Elapsed:", end - start)