For Developers

👌 1. Register a Topic (Create Stream)

Frontend: 👉 https://stream.dephy.dev/

1. Open the sidebar → Create Stream tab.

   
2. Fill in:

   • Name — Topic name

   • Description — optional

   • Admin — nostr pubkey of the topic administrator

   • Publish Mode — Public or Private

   • Access Mode — Public, Private, or Subscription

3. Click Create Stream.

Mode Notes

⚙️ Auth Epoch Delay: After granting permissions or processing payment, expect a short delay (~5 min by default) before the auth service updates. You can adjust this in your deployed dephy-mn-auth configuration.

👌 2. How to Get Access to a Topic

1. Open the sidebar → Streams tab.

   
2. Open qingping_air_monitor stream.

   

Admins can manage permissions (grant/revoke publish / grant/revoke access) from the Streams tab when signed in.

👌 3. How to Subscribe to a Topic

1. Open the Topic page.

2. If it’s a Subscription type, click Subscribe and complete payment.

   
3. Wait for the auth epoch (~5 min).

4. Refresh to view stream events.

   

👌 4. Add a New Device Type to hass2nostr

Device modules live under: src/device-types/*.ts

Each must export:

Implementation Notes

• See examples: qingping_air_monitor.ts, chunmi_tsa1.ts, zhimi_mp4a.ts

• The CLI imports these modules (src/cli/bridge.ts, src/cli/simulate.ts) and filters Home Assistant states accordingly.

• Keep filename = deviceType name (e.g. -w qingping_air_monitor loads src/device-types/qingping_air_monitor.ts).

Minimal Checklist

1. Create src/device-types/<your_device>.ts

2. Export required constants/functions

3. Implement truncateAttributes()

4. Add processState() and simulateHassState()

5. Test with:

deno task run simulate -r wss://canary-relay.dephy.dev -w <your_device>

Example

export const entityPrefixes = ["sensor.my_vendor_thing_"];
export const allowedEntitySuffixes = ["temperature", "humidity"];
export const allowedAttributes = [
  "state_class",
  "unit_of_measurement",
  "device_class",
];

export function truncateAttributes(attrs) {
  const allowed = {};
  for (const key of allowedAttributes) {
    if (key in attrs) allowed[key] = attrs[key];
  }
  return allowed;
}

export function processState(states) {
  return states.map((s) => truncateState(s, truncateAttributes));
}

export function simulateHassState(device) {
  // Return mock HassState[] for testing
}