summaryrefslogtreecommitdiff
path: root/smart_home/device.py
diff options
context:
space:
mode:
Diffstat (limited to 'smart_home/device.py')
-rw-r--r--smart_home/device.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/smart_home/device.py b/smart_home/device.py
index 06187d7..82f1fa6 100644
--- a/smart_home/device.py
+++ b/smart_home/device.py
@@ -1,5 +1,9 @@
#!/usr/bin/env python3
+"""Most basic definition of a smart device: it must have a name and a
+MAC address and may have some optional keywords. All devices have
+these whether they are lights, outlets, thermostats, etc..."""
+
import re
from typing import List, Optional
@@ -7,6 +11,10 @@ import arper
class Device(object):
+ """Most basic definition of a smart device: it must have a name and a
+ MAC address and may have some optional keywords. All devices have
+ these whether they are lights, outlets, thermostats, etc..."""
+
def __init__(
self,
name: str,