public interface HomeBridge

The current availability, as the ordinal of a com.codename1.home.HomeAvailability constant.

May be called before start(int) and must answer without blocking.

Build configuration this backend needs and does not have – a missing entitlement, a missing Google Cloud project id – one human-readable sentence per problem, each naming the build hint that fixes it.

Empty when nothing is missing. This is what com.codename1.home.HomeConfigurationException carries, so the text is read by a developer, not by a user.

Whether accessory and structure identifiers survive an app restart.

Both shipping backends answer true; a local or test bridge that regenerates its graph does not, and an app persisting a favourite should ask.

The homes, one per entry: id \t name \t primary \t owner \t sceneAuthoring, where the three flags are 1 or 0.

Synchronous, and must not block: the bridge caches the platform’s model and this reads the cache. refresh(int) is what reloads it.

The zones of one home, one per entry: id \t name \t roomId,roomId,....

Empty on every backend but HomeKit, which is the only one with zones.

The accessories of one home, one per entry: id \t name \t roomId \t categoryOrdinal \t manufacturer \t model \t firmware \t reachable \t bridgeAccessoryId.

roomId and bridgeAccessoryId are empty when absent; reachable is 1 or 0; categoryOrdinal indexes com.codename1.home.AccessoryCategory.

The services of one accessory, one per entry: id \t name \t serviceTypeOrdinal \t primary.

serviceTypeOrdinal indexes com.codename1.home.ServiceType; primary is 1 or 0.

The traits of one service, one per entry: traitId \t readable \t writable \t notifies \t hasRange \t min \t max \t step \t validOrdinalsCsv.

The four flags are 1 or 0; the three numbers are decimal and are ignored when hasRange is 0; validOrdinalsCsv is empty when the accessory did not enumerate its values.

A traitId this build does not know is skipped by the decoder rather than failing the row, so a newer port degrades gracefully.

Reads traits. Answers through SmartHome.deliverReadings.

The three arrays are positionally aligned and of equal length.

Writes traits. Answers through SmartHome.deliverWriteResults.

All the arrays are positionally aligned and of equal length. Each value is carried in whichever of numericValues or stringValues suits its kind: a boolean as 1 or 0, an int and an enum ordinal as themselves, a double with its unit in unitWireIds, a string in stringValues with the numeric slot ignored.

Whether this backend pushes trait changes without being asked.

true only where the platform genuinely delivers while the app runs. A backend that answers false must still accept subscribe and gather changes for drainChanges(int).

Starts watching traits. Changes arrive through SmartHome.deliverChanges carrying the same subscriptionId.

Coalescing is not the bridge’s job: the framework applies the caller’s window before anything reaches the EDT, so a port should deliver what the platform gives it.

Hands over changes gathered since the last drain, through SmartHome.deliverChanges for each affected subscription, then answers SmartHome.deliverDrained.

The only way changes arrive at all where isPushDelivery() is false.

The scenes of one home, one per entry: id \t name \t typeOrdinal \t executable.

typeOrdinal indexes com.codename1.home.SceneType; executable is 1 or 0.

What one scene does, one action per entry: accessoryId \t serviceId \t traitId \t kindOrdinal \t numericValue \t stringValue \t unitWireId.

Empty where the backend will run a scene but not enumerate it, which is a real answer rather than an empty scene.

Creates a scene. Answers through SmartHome.deliverSceneResult, whose scene id is the new scene’s.

The value arrays are encoded exactly as in writeTraits.