Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [v0.9.0] - 2026-06-30

### Added

- Support for OTA Events

## [v0.8.1] - 2025-11-06

### Changed
Expand Down
94 changes: 94 additions & 0 deletions golioth/golioth.py
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ def __init__(self, client: Client, info: dict[str, Any]):
self.blueprints: ProjectBlueprints = ProjectBlueprints(self)
self.cohorts: ProjectCohorts = ProjectCohorts(self)
self.packages: ProjectPackages = ProjectPackages(self)
self.ota_events: ProjectOTAEvents = ProjectOTAEvents(self)
self.tags: ProjectTags = ProjectTags(self)

@property
Expand Down Expand Up @@ -1199,6 +1200,99 @@ async def update(self, package_id: str, description: str,
return Package(resp.json()['data'])


class OTAEvent(ApiNodeMixin):
class Error(ApiException):
pass

class ErrMsgFromServer(Error):
pass

def __init__(self, info: dict[str, Any]):
self.info = info

@property
def deviceId(self) -> str:
return self.info['deviceId']

@property
def packageId(self) -> str:
return self.info['packageId']

@property
def eventType(self) -> str:
return self.info['eventType']

@property
def status(self) -> int:
return self.info['status']

@property
def message(self) -> int:
return self.info['message']

@property
def currentVersion(self) -> int:
return self.info['currentVersion']

@property
def targetVersion(self) -> int:
return self.info['targetVersion']

@property
def datetime(self) -> datetime:
ts = re.sub(r'(\d{6})\d*Z$', r'\g<1>+00:00', self.info['timestamp'])
return datetime.fromisoformat(ts)

def __repr__(self):
return (f'OTAEvent <packageId={self.packageId}, deviceId={self.deviceId}, ' +
f'eventType={self.eventType}, status={self.status}, ' +
f'currentVersion={self.currentVersion}, targetVersion={self.targetVersion}, ' +
f'message={self.message}, datetime={self.datetime}>')


class ProjectOTAEvents(ApiNodeMixin):
def __init__(self, project: Project):
self.project = project
self.base_url = f'{self.project.base_url_with_org}/ota-events'

@property
def headers(self) -> Dict[str, str]:
return self.project.headers

async def get(self,
cohortId: Optional[str] = None,
packageId: Optional[str] = None,
deviceId: Optional[str] = None,
eventType: Optional[str] = None,
status: Optional[int] = None,
startTime: Optional[datetime] = None,
endTime: Optional[datetime] = None,
limit: Optional[int] = None,
pageToken: Optional[str] = None) -> list[OTAEvent]:
params = {
'cohortId': cohortId,
'packageId': packageId,
'deviceId': deviceId,
'eventType': eventType,
'status': status,
'startTime': startTime.isoformat() if startTime is not None else None,
'endTime': endTime.isoformat() if endTime is not None else None,
'limit': limit,
'pageToken': pageToken,
}
params = {k: v for k, v in params.items() if v is not None}
try:
resp = await self.project.get(self.base_url, params=params, timeout=30)
except httpx.HTTPStatusError as err:
try:
msg = err.response.json()['message']
except (json.JSONDecodeError, KeyError):
msg = err.response.text
if msg != None and msg != "":
raise OTAEvent.ErrMsgFromServer(msg) from err
raise err
return [OTAEvent(oe) for oe in resp.json()['list']]

class Blueprint(ApiNodeMixin):
class Error(ApiException):
pass
Expand Down