Skip to content

chore: update ConnectionStatus to reflect changes #134

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

Merged
jhgjeraker merged 1 commit into from
Feb 21, 2024
Merged

chore: update ConnectionStatus to reflect changes #134

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 21 additions & 10 deletions disruptive/events/events.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1291,15 +1291,24 @@ class ConnectionStatus(_EventData):
Attributes
----------
connection : str
Whether the Cloud Connector is on "ETHERNET", "CELLULAR", or "OFFLINE".
Whether the current connection is
SDS, ETHERNET, CELLULAR, or OFFLINE.
available : list[str]
Lists available connections. Can contain
"ETHERNET", "CELLULAR", or both.
A list of the string types of networks available to the device.
For Cloud Connectors, this can contain the values
ETHERNET, CELLULAR, or both. For Sensors, it will contain
only SDS when its online. This field will be empty when
the device's connection is OFFLINE.
timestamp : datetime
Timestamp of when the event was received by a Cloud Connector.

"""

CONNECTION_SDS: str = 'SDS'
CONNECTION_ETHERNET: str = 'ETHERNET'
CONNECTION_CELLULAR: str = 'CELLULAR'
CONNECTION_OFFLINE: str = 'OFFLINE'

def __init__(self,
connection: str,
available: list[str],
Expand All @@ -1311,14 +1320,16 @@ def __init__(self,
Parameters
----------
connection : str
Whether the Cloud Connector is on
"ETHERNET", "CELLULAR", or "OFFLINE".
Whether the current connection is
SDS, ETHERNET, CELLULAR, or OFFLINE.
available : list[str]
Lists available connections.
Can contain "ETHERNET", "CELLULAR", or both.
timestamp : datetime, str, optional
Timestamp in either datetime or string iso8601 format
(i.e. yyyy-MM-ddTHH:mm:ssZ).
A list of the string types of networks available to the device.
For Cloud Connectors, this can contain the values
ETHERNET, CELLULAR, or both. For Sensors, it will contain
only SDS when its online. This field will be empty when
the device's connection is OFFLINE.
timestamp : datetime
Timestamp of when the event was received by a Cloud Connector.

"""

Expand Down