Skip to content

Commit 0e51264

Browse files
docs: add comprehensive Sphinx RST documentation for Devices class
Documented all 21 Devices class methods with descriptions, parameters, return types, and code examples. Added TypedDict documentation for new data structures including DeviceChunkData, DeviceDataBackup, DeviceDataBackupResponse, and DeviceDataRestore. All documentation follows RST formatting standards with proper cross-references and builds successfully without warnings.
1 parent 9e07d43 commit 0e51264

2 files changed

Lines changed: 615 additions & 125 deletions

File tree

docs/source/Resources/Devices/Devices_Type.rst

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -485,3 +485,77 @@ ListDeviceTokenQuery
485485
]]
486486
| [Optional] Tuple with a field and an order
487487
488+
489+
.. _DeviceChunkData:
490+
491+
DeviceChunkData
492+
---------------
493+
494+
Chunk information from an immutable device.
495+
496+
**Attributes:**
497+
498+
| **id**: str
499+
| Chunk ID in format 'from_to' (Unix timestamps).
500+
501+
| **from_date**: str
502+
| Start date of the chunk (ISO 8601).
503+
504+
| **to_date**: str
505+
| End date of the chunk (ISO 8601).
506+
507+
| **amount**: int or float
508+
| Amount of data records in the chunk.
509+
510+
511+
.. _DeviceDataBackup:
512+
513+
DeviceDataBackup
514+
----------------
515+
516+
Parameters for device data backup operation.
517+
518+
**Attributes:**
519+
520+
| **deviceID**: :ref:`GenericID`
521+
| Device ID.
522+
523+
| **file_address**: str
524+
| File path in TagoIO Files where backup will be saved.
525+
| Can use template variables: $DEVICE$, $CHUNK$, $FROM$, $TO$, $TIMESTAMP$.
526+
527+
| **headers**: Optional[bool]
528+
| [Optional] Include CSV headers in the exported file.
529+
530+
531+
.. _DeviceDataBackupResponse:
532+
533+
DeviceDataBackupResponse
534+
------------------------
535+
536+
Response from device data backup operation.
537+
538+
**Attributes:**
539+
540+
| **file_address**: str
541+
| Final file path where the backup was saved.
542+
543+
| **chunk_id**: Optional[str]
544+
| [Optional] Chunk ID if backup was for a specific chunk.
545+
546+
547+
.. _DeviceDataRestore:
548+
549+
DeviceDataRestore
550+
-----------------
551+
552+
Parameters for device data restore operation.
553+
554+
**Attributes:**
555+
556+
| **deviceID**: :ref:`GenericID`
557+
| Device ID.
558+
559+
| **file_address**: str
560+
| File path in TagoIO Files to restore data from (CSV format).
561+

0 commit comments

Comments
 (0)