Skip to content

Commit 1c15ae8

Browse files
author
Marcel Hecko
committed
update documentation
1 parent 2763ee8 commit 1c15ae8

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

pySigfox/pySigfox.py

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,12 @@ def device_types_list(self):
3737
def device_list(self, device_type_id = 0):
3838
"""Return array of dictionaries - one array item per device.
3939
40-
If device_type_id is not set devices of all device types are returned!
40+
:param device_type_id: Return only devices of a certain type ID.
41+
If set to 0 returns all devices of all types (default)!
42+
:type device_type_id: int
43+
:return: List of dictionaries
44+
:rtype: list
45+
4146
"""
4247
device_type_ids = []
4348
out = []
@@ -54,13 +59,15 @@ def device_list(self, device_type_id = 0):
5459
return out
5560

5661
def device_messages(self, device_id):
57-
"""Return array of messages from device with ID defined in device_id.
58-
Limit of 100 is the maximum Sigfox API will accept.
62+
"""Return array of 100 last messages from device.
63+
64+
:param device_id: ID of the device
65+
:type device_id: str
5966
6067
"""
6168
out = []
6269

63-
url = self.api_url + 'devices/' + device_id + '/messages?limit=100'
70+
url = self.api_url + 'devices/' + str(device_id) + '/messages?limit=100'
6471
r = requests.get(url, auth=requests.auth.HTTPBasicAuth(self.login, self.password))
6572
pprint(json.loads(r.text)['paging']['next'])
6673

@@ -72,11 +79,10 @@ def device_messages(self, device_id):
7279

7380
try:
7481
json.loads(r.text)['paging']['next']
75-
print("Loading next page...")
82+
print("Loading next page of messages for " + str(device_id) + "...")
7683
out.extend(self.device_messages_page(json.loads(r.text)['paging']['next']))
7784
except Exception as e:
78-
# print("No paging")
79-
raise
85+
raise
8086

8187
return out
8288

0 commit comments

Comments
 (0)