docs: Document Ultraloq integration #1048
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add comprehensive documentation for the Ultraloq smart lock integration, including the unique timezone configuration requirement for time-bound access codes. New documentation: - Ultraloq integration overview (README.md) - Setup guide with OAuth flow and timezone configuration - Detailed timezone configuration guide - Access code creation guide (permanent and time-bound codes) Updates: - Add Ultraloq to SUMMARY.md navigation (alphabetically between TTLock and Wyze) - Enhance /devices/report_provider_metadata API reference with Ultraloq use case and examples - Update access code constraints guide to include provider-specific timezone requirements The Ultraloq integration is unique in requiring manual timezone configuration before creating time-bound access codes, as Ultraloq devices schedule codes using device-local time without reporting their timezone. Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
Update the timezone requirement detection code sample to include examples in Python, JavaScript, Ruby, PHP, C#, Java, and cURL, consistent with other SDK code samples throughout the documentation.
Expand the Next Steps section with working code examples for: - Lock and unlock operations - Creating permanent access codes - Creating time-bound access codes - Monitoring device status (lock status, online/offline, battery) All examples include multi-language tabs (Python, JS, Ruby, PHP, C#, Java, cURL) to help developers quickly implement common operations after setup.
Add requirement that ALL code examples must include all supported Seam SDK languages (Python, JavaScript, Ruby, PHP, C#, Java) plus cURL for direct API access. Update the multi-language code example section with: - Explicit requirement to include all languages - Complete example showing all 7 languages - Standard language ordering - Guidance on when to include code examples This ensures consistency across all documentation and makes it easier for developers using different languages to find relevant examples.
Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive documentation for the Ultraloq smart lock integration to docs.seam.co.
Linear issue: ENG-65
What's unique about Ultraloq
The Ultraloq integration requires manual timezone configuration before creating time-bound access codes. This is unique among Seam integrations because:
Documentation added
New integration guide pages:
Main overview (README.md)
Setup guide (ultraloq-setup-guide.md)
Timezone configuration guide (configuring-ultraloq-device-timezones.md)
ultraloq_time_zone_unknownwarning)Access codes guide (creating-ultraloq-access-codes.md)
ultraloq_access_code_disabledwarning)Updates to existing pages:
Key features documented
✅ OAuth connection flow
✅ Device timezone configuration (
/devices/report_provider_metadataAPI)✅ Permanent access codes (work without timezone)
✅ Time-bound access codes (require timezone)
✅ Warning system (
ultraloq_time_zone_unknown,ultraloq_access_code_disabled)✅ Code validation (4-8 digit numeric PINs)
✅ Multi-language code examples (7 languages)
✅ Best practices and troubleshooting
Assets needed (to be added later)
The following assets should be added to complete the documentation:
Ultraloq manufacturer cover image (light mode)
docs/.gitbook/assets/ultraloq-manufacturer-page-cover-light.pngUltraloq manufacturer cover image (dark mode) [optional]
docs/.gitbook/assets/ultraloq-manufacturer-page-cover-dark.pngUltraloq logo
docs/.gitbook/assets/ultraloq-logo.pngDocumentation quality
Test plan
🤖 Generated with Claude Code