aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarek Siarkowicz <mareksiarkowicz@gmail.com>2015-06-14 17:48:33 +0200
committerMarek Siarkowicz <mareksiarkowicz@gmail.com>2015-06-14 17:48:33 +0200
commitf3425cc12cdc5837625ae490ab2302ecfafc0453 (patch)
tree787db68ec54ba033662d2da18b7e4d6e60d1d667
parent7e32d6a1829b99eac6e0150dd4a80062801d6ffe (diff)
downloadpyParrotZikTCP-f3425cc12cdc5837625ae490ab2302ecfafc0453.tar.xz
pyParrotZikTCP-f3425cc12cdc5837625ae490ab2302ecfafc0453.zip
Create api doc.
-rw-r--r--ParrotZik.py27
1 files changed, 27 insertions, 0 deletions
diff --git a/ParrotZik.py b/ParrotZik.py
index 1240d66..4f4ff07 100644
--- a/ParrotZik.py
+++ b/ParrotZik.py
@@ -194,6 +194,17 @@ class ParrotZikBase(object):
class ParrotZikVersion1(ParrotZikBase):
+ '''
+ Known resources:
+ * /api/software/version
+ * /api/system/battery
+ * /api/bluetooth/friendlyname
+ * /api/system/auto_connection/enabled
+ * /api/system/anc_phone_mode/enabled
+ * /api/audio/specific_mode/enabled
+ * /api/audio/sound_effect/enabled
+ * /api/audio/noise_cancellation/enabled
+ '''
@property
def battery_level(self):
return int(self.get_battery_level('level'))
@@ -230,6 +241,22 @@ class ParrotZikVersion1(ParrotZikBase):
class ParrotZikVersion2(ParrotZikBase):
+ '''
+ Known resources:
+ * /api/software/version
+ * /api/system/battery
+ * /api/system/pi
+ * /api/bluetooth/friendlyname
+ * /api/system/auto_connection/enabled
+ * /api/system/anc_phone_mode/enabled
+ * /api/flight_mode
+ * /api/sound_effect/enabled
+ * /api/sound_effect/room_size
+ * /api/sound_effect/angle
+ * /api/audio/noise
+ * /api/audio/noise_control
+ * /api/audio/noise_control/enabled
+ '''
@property
def battery_level(self):
return self.get_battery_level('percent')