Skip to content

API key handling #22

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.

Sign up for GitHub

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

Open
RenoFilla wants to merge 5 commits into
base: master
Choose a base branch
from
Open

API key handling #22

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
21eb011
Update __init__.py
Jun 30, 2022
3ce3826
Update __init__.py
Jun 30, 2022
6a8d211
Update __init__.py
Jun 30, 2022
62be297
Update __init__.py
Jun 30, 2022
6e8a59b
added get_api_keys()
Jul 4, 2022
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
74 changes: 58 additions & 16 deletions thingspeak/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,17 @@ class Channel(object):
def __init__(
self,
id,
api_key=None,
user_api_key=None,
read_api_key=None,
write_api_key=None,
fmt="json",
timeout=None,
server_url="https://api.thingspeak.com",
):
self.id = id
self.api_key = api_key
self.user_api_key = user_api_key
self.read_api_key = read_api_key
self.write_api_key = write_api_key
self.fmt = ("." + fmt) if fmt in ["json", "xml"] else ""
self.timeout = timeout
self.server_url = server_url
Expand All @@ -28,14 +32,30 @@ def get(self, options=None):
"""
if options is None:
options = dict()
if self.api_key is not None:
options["api_key"] = self.api_key
if self.read_api_key is not None:
options["api_key"] = self.read_api_key
url = "{server_url}/channels/{id}/feeds{fmt}".format(
server_url=self.server_url, id=self.id, fmt=self.fmt
)
r = requests.get(url, params=options, timeout=self.timeout)
return self._fmt(r)

def get_last(self, options=None):
"""Get a last entry in channel feed.

`get-a-channel-feed
<https://mathworks.com/help/thingspeak/readlastentry.html>`_
"""
if options is None:
options = dict()
if self.read_api_key is not None:
options["api_key"] = self.read_api_key
url = "{server_url}/channels/{id}/feeds/last{fmt}".format(
server_url=self.server_url, id=self.id, fmt=self.fmt
)
r = requests.get(url, params=options, timeout=self.timeout)
return self._fmt(r)

def get_field(self, field=None, options=None):
"""Get particular field

Expand All @@ -44,8 +64,8 @@ def get_field(self, field=None, options=None):
"""
if options is None:
options = dict()
if self.api_key is not None:
options["api_key"] = self.api_key
if self.read_api_key is not None:
options["api_key"] = self.read_api_key
url = "{server_url}/channels/{id}/fields/{field}{fmt}".format(
server_url=self.server_url, id=self.id, field=field, fmt=self.fmt
)
Expand All @@ -60,8 +80,8 @@ def get_field_last(self, field=None, options=None):
"""
if options is None:
options = dict()
if self.api_key is not None:
options["api_key"] = self.api_key
if self.read_api_key is not None:
options["api_key"] = self.read_api_key
url = "{server_url}/channels/{id}/fields/{field}/last{fmt}".format(
server_url=self.server_url, id=self.id, field=field, fmt=self.fmt
)
Expand All @@ -76,8 +96,8 @@ def get_last_data_age(self, field=None, options=None):
"""
if options is None:
options = dict()
if self.api_key is not None:
options["api_key"] = self.api_key
if self.read_api_key is not None:
options["api_key"] = self.read_api_key
url = "{server_url}/channels/{id}/fields/{field}/last_data_age{fmt}"
url = url.format(
server_url=self.server_url, id=self.id, field=field, fmt=self.fmt
Expand All @@ -89,27 +109,49 @@ def view(self):
"""View a Channel

`view-a-channel
<https://de.mathworks.com/help/thingspeak/view-a-channel.html>`_
<https://mathworks.com/help/thingspeak/view-a-channel.html>`_
"""
options = dict()
if self.api_key is not None:
options["api_key"] = self.api_key
if self.user_api_key is not None:
options["api_key"] = self.user_api_key
url = "{server_url}/channels/{id}{fmt}".format(
server_url=self.server_url, id=self.id, fmt=self.fmt
)
r = requests.get(url, params=options, timeout=self.timeout)
return self._fmt(r)

def get_api_keys(self):
"""Get Read/Write API Keys a Channel

`control-a-channel
<https://se.mathworks.com/help/thingspeak/channel-control.html>`_
"""
import json
v_json = self.view()
v = json.loads(v_json)
read_api_key = None
write_api_key = None
for k in v['api_keys']:
if k['write_flag']:
if write_api_key is None:
write_api_key = k['api_key']
else:
if read_api_key is None:
read_api_key = k['api_key']
setattr(self,'read_api_key', read_api_key)
setattr(self,'write_api_key', write_api_key)
return read_api_key, write_api_key

def update(self, data):
"""Update channel feed.

`update-channel-feed
<https://mathworks.com/help/thingspeak/update-channel-feed.html>`_
"""
if self.api_key is not None:
data["api_key"] = self.api_key
if self.write_api_key is not None:
data["api_key"] = self.write_api_key
else:
raise ValueError("Missing api_key")
raise ValueError("Missing write api_key")
url = "{server_url}/update{fmt}".format(
server_url=self.server_url, id=self.id, fmt=self.fmt
)
Expand Down