Horologist

Horologist is a group of libraries that aim to supplement Wear OS developers with features that are
commonly required by developers but not yet available.

Maintained Versions

The currently maintained branches of Horologist are.

Maintenance branches will not delete existing APIs and they should remain stable. However
the main branch will actively update to incorporate new API guidance, removing or changing
APIs.

🎵 Media

Horologist provides the Media Toolkit: a set of libraries to build Media apps on Wear OS and a
sample app that you can run to see the toolkit in action.

The toolkit includes:

• horologist-media-ui: common media UI components
  and screens like PlayerScreen.
• horologist-media: domain model for Media related
  functionality. Provides an
  abstraction
  to the UI module (horologist-media-ui) that is agnostic to the Player implementation.
• horologist-media-data: implementation of the
  domain module (horologist-media)
  using Media3.
• horologist-media3-backend: Player on top of
  Media3 including
  functionalities
  such as avoiding playing music on the watch speaker.
• media sample: sample app to listen to
  downloaded music.
• audio: domain model for Audio related functionality,
  such as Volume Control and Output switching, subscribing to a Flow of changes in audio or output.
• audio-ui: UI components for Audio related functionality,
  such as Volume Control and Output switching

Player Screen	Browse Screen	Entity Screen	Volume Screen

📅 Composables

High quality prebuilt composables, such as Time and Date pickers.

• horologist-composables

DatePicker	TimePickerWith12HourClock	TimePicker

SegmentedProgressIndicator

📐 Compose Layout

Layout related functionality such as a Navigation Aware Scaffold.

• horologist-compose-layout

fillMaxRectangle()

🔲 Compose Material

Opinionated implementation of the components of
the Wear Material Compose library
, based on the specifications
of Wear Material Design Kit
.

• horologist-compose-material

🔐 Auth

Libraries to help developers to build apps following
the Sign-In guidelines for Wear OS
.

• horologist-auth-composables: composable
  screens for authentication use
  cases, with no dependency on the auth-data library.
• horologist-auth-ui: composable screens for
  authentication use cases, with integration
  with the auth-data library
• horologist-auth-data: implementation for Wear
  apps for most of the authentication
  methods listed in
  the Authentication on wearables
  guide.
• horologist-auth-data-phone: implementation
  for Mobile apps for some of the
  authentication methods provided by the auth-data library.
• sample wear: sample wear app
  to authenticate using different methods.
• sample phone: sample phone
  app to authenticate using different methods.

DataLayer

The Horologist DataLayer library, provide common abstractions on top of the
Wearable DataLayer.
It includes libraries to build
prompts on the phone to improve
engagement with the correspondent Wear app and a
sample to see the prompts in actions.
Find guidance in the project documentation.

☰ Tiles

Kotlin coroutines flavoured TileService.

horologist-tiles

Why the name?

The name mirrors the Accompanist name, and is also Watch
related.

https://en.wiktionary.org/wiki/horologist

horologist (Noun)
Someone who makes or repairs timepieces, watches or clocks.

Contributions

Please contribute! We will gladly review any pull requests submitted.
Make sure to read the Contributing page to know what our expectations of
contributions are.

License

Copyright 2023 The Android Open Source Project

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.