---
url: >-
  https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ProtocolConfig.md
description: The configurable wire tags used by a local diffusion backend.
---

# Type Alias: ProtocolConfig

```ts
type ProtocolConfig = {
  commandPrefix: string;
  control: {
    shutdown: string;
    stop: string;
  };
  eventPrefix: string;
  events: {
    done: string;
    error: string;
    image: string;
    modelLoad: string;
    progress: string;
    ready: string;
  };
  ops: {
    edit: string;
    generate: string;
  };
};
```

Defined in: [src/batteries/generation/local\_diffusion/protocol.ts:18](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L18)

The configurable wire tags used by a local diffusion backend.

## Properties

| Property                                            | Type                                                                                                                          | Description                                                            | Defined in                                                                                                                                                              |
| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|  `commandPrefix` | `string`                                                                                                                      | Leading tag on every host→backend command line (DiffusionBee: `b2py`). | [src/batteries/generation/local\_diffusion/protocol.ts:20](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L20) |
|  `control`             | { `shutdown`: `string`; `stop`: `string`; }                                                                                 | Control-command sub-tags (no request payload).                         | [src/batteries/generation/local\_diffusion/protocol.ts:31](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L31) |
| `control.shutdown`                                  | `string`                                                                                                                      | Graceful backend shutdown request (DiffusionBee: `__shutdown__`).      | [src/batteries/generation/local\_diffusion/protocol.ts:35](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L35) |
| `control.stop`                                      | `string`                                                                                                                      | Advisory cancel of the current request (DiffusionBee: `__stop__`).     | [src/batteries/generation/local\_diffusion/protocol.ts:33](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L33) |
|  `eventPrefix`     | `string`                                                                                                                      | Leading tag on every backend→host event line (DiffusionBee: `sdbk`).   | [src/batteries/generation/local\_diffusion/protocol.ts:22](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L22) |
|  `events`               | { `done`: `string`; `error`: `string`; `image`: `string`; `modelLoad`: `string`; `progress`: `string`; `ready`: `string`; } | Backend→host event sub-tags.                                           | [src/batteries/generation/local\_diffusion/protocol.ts:38](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L38) |
| `events.done`                                       | `string`                                                                                                                      | Request-complete terminal event (DiffusionBee: `done`).                | [src/batteries/generation/local\_diffusion/protocol.ts:48](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L48) |
| `events.error`                                      | `string`                                                                                                                      | Request-error terminal event (DiffusionBee: `err`).                    | [src/batteries/generation/local\_diffusion/protocol.ts:50](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L50) |
| `events.image`                                      | `string`                                                                                                                      | One finished image result event (DiffusionBee: `nwim`).                | [src/batteries/generation/local\_diffusion/protocol.ts:46](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L46) |
| `events.modelLoad`                                  | `string`                                                                                                                      | Startup model-load progress event (DiffusionBee: `mdld`).              | [src/batteries/generation/local\_diffusion/protocol.ts:40](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L40) |
| `events.progress`                                   | `string`                                                                                                                      | Per-step generation progress event (DiffusionBee: `dnpr`).             | [src/batteries/generation/local\_diffusion/protocol.ts:44](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L44) |
| `events.ready`                                      | `string`                                                                                                                      | Backend-ready event that resolves preload (DiffusionBee: `rdy`).       | [src/batteries/generation/local\_diffusion/protocol.ts:42](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L42) |
|  `ops`                     | { `edit`: `string`; `generate`: `string`; }                                                                                 | Operation sub-tags for the two request commands.                       | [src/batteries/generation/local\_diffusion/protocol.ts:24](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L24) |
| `ops.edit`                                          | `string`                                                                                                                      | image+text→image edit op sub-tag (DiffusionBee: `im2im`).              | [src/batteries/generation/local\_diffusion/protocol.ts:28](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L28) |
| `ops.generate`                                      | `string`                                                                                                                      | text→image generate op sub-tag (DiffusionBee: `t2im`).                 | [src/batteries/generation/local\_diffusion/protocol.ts:26](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L26) |