Default package

Get desktop application:
View/edit binary Protocol Buffers messages

An authentication token, which a drinker uses to authenticate to the system.

• required uint32 id = 1

  The unique identifier for this token.

• required string auth_device = 2

  The name of the auth device that owns this token, such as ``core.onewire`` or ``contrib.phidget.rfid``.

• required string token_value = 3

  The unique key.

• optional string username = 4

  The user owning the token.

• optional string nice_name = 5

  An optional human-readable name for this token.

• optional bool enabled = 6

  True if the token is enabled.

• required string created_time = 7

  The date the token was created, as an ISO8061 UTC timestamp.

• optional string expire_time = 8

  The date after which the token is invalid, as an ISO8061 UTC timestamp. Only available to admin users.

• optional string pin = 9

  The token's pin, if any. Only available to admin users.

• optional User user = 10

A named beer style of beer, such as "India Pale Ale".

• required uint32 id = 1

  The unique identifier for this beer style.

• required string name = 2

  The name of the beer style.

A specific kind of beer: describes the beer's name, style, and brewer.

Used in: Keg

• required string id = 1

  The unique identifier for this beer type.

• required string name = 2

  The brand name of the beer.

• required string brewer_id = 3

  Brewer information for the beer. May refer to an 'unknown' or generic brewer record.

• required string style_id = 4

  Style information for the beer. May refer to an 'unknown' or generic beer style.

• optional string edition = 6

  For seasonal or special edition beers, the year or other edition name.

• optional double abv = 7

  Alcohol by volume, as a percentage of the total volume.

• optional double calories_oz = 8

  Number of calories per ounce of beverage.

• optional double carbs_oz = 9

  Number of carbohydrates per ounce of beverage.

• optional double specific_gravity = 10

  Specific/final gravity of the beer, if known.

• optional double original_gravity = 11

  Original gravity of the beer, if known.

• optional Image image = 12

  Image for this beer.

A type of beer, coffee, wine, or other beverage.

Used in: Keg

• required uint32 id = 1

  Unique id for this beverage.

• required string name = 2

  Beverage name.

• required BeverageProducer producer = 3

  Producer.

• required string beverage_type = 4

  Type of beverage.

• optional string style = 5

  Beverage style.

• optional string description = 6

  Free-form description.

• optional Image picture = 7

  Logo or other image.

• optional uint32 vintage_year = 8

  Vintage.

• optional double abv_percent = 9

  Alcohol by volume (0.0-100.0).

• optional double calories_per_ml = 10

  Calories.

• optional double carbs_per_ml = 11

  Carbohydrates.

• optional double original_gravity = 12

  Original gravity.

• optional double specific_gravity = 13

  Specific gravity.

• optional string untappd_id = 14

  Untappd id (for beers only).

• optional string beverage_backend = 15

  Beverage backend.

• optional string beverage_backend_id = 16

  Id within beverage backend.

• optional string color_hex = 17

• optional double srm = 18

• optional double ibu = 19

• optional double star_rating = 20

A beverage production company or brand.

Used in: Beverage

• required uint32 id = 1

  The unique identifier for this producer.

• required string name = 2

  The name of the brewer or production company.

• optional string country = 3

  Country of origin.

• optional string origin_state = 4

  State of origin.

• optional string origin_city = 5

  City of origin.

• optional bool is_homebrew = 6

  True if this is a home producer.

• optional string url = 7

  URL for producer.

• optional string description = 8

  Free-form description.

• optional Image picture = 9

  Image.

A specific producer of our favorite beverage.

• required string id = 1

  The unique identifier for this beer type.

• required string name = 2

  The name of the brewer.

• optional string country = 3

  The country of the brewer's headquarters.

• optional string origin_state = 4

  The state of the brewer's headquarters.

• optional string origin_city = 5

  The city of the brewer's headquarters.

• optional string production = 6

  Type of production (usually either 'retail' or 'homebrew').

• optional string url = 7

  URL of brewer.

• optional string description = 8

  Free-form description.

• optional Image image = 9

  Image or logo for this brewer.

Describes a hardware controller

Used in: FlowMeter, FlowToggle, SyncResponse

• required uint32 id = 1

• required string name = 2

• optional string model_name = 3

• optional string serial_number = 4

Describes a single recorded pour from the Kegbot.

Used in: SyncResponse, SystemEvent

• required uint32 id = 1

  The unique identifier for this drink.

• required uint32 ticks = 2

  The number of meter ticks recorded for the drink.

• required double volume_ml = 3

  The volume of the drink, in milliliters.

• required uint32 session_id = 4

  The session this drink belongs to.

• required string time = 5

  UTC time when the drink was poured, as an ISO8061 UTC timestamp.

• optional uint32 duration = 6

  Duration, in seconds, of the pour.

• optional uint32 keg_id = 8

  The Keg from which the drink was poured. May be unset if the drink was not associated with a keg.

• optional string user_id = 9

  The User that poured the drink. Snset if the drinker was unknown (anonymous pour).

• optional uint32 auth_token_id = 10

  Auth token value used to pour the drink, if known.

• optional string url = 11

  Canonical URL for this object.

• optional string shout = 12

  Comment from the drinker at the time of the pour.

• optional User user = 13

• optional Keg keg = 14

• optional Session session = 15

• repeated Image images = 16

• optional string tick_time_series = 17

  Vector of tick updates. Format is: "<time>:<amount> [<time>:<amount> ...]", where "time" is the delta (in ms) from the previous reading, and "amount" is the delta in ticks from the previous reading.

Used in: KegTap, SyncResponse

• required uint32 id = 1

• required string name = 2

• required string port_name = 3

• required double ticks_per_ml = 4

• optional Controller controller = 5

Used in: KegTap, SyncResponse

• required uint32 id = 1

• required string name = 2

• required string port_name = 3

• optional Controller controller = 4

Describes an image.

Used in: BeerType, Beverage, BeverageProducer, Brewer, Drink, SystemEvent, User

• required string url = 1

  The default URL of this image.

• optional uint32 width = 2

  The width of the image in pixels.

• optional uint32 height = 3

  The height of the image in pixels.

• optional string time = 4

  The date the picture was created.

• optional string caption = 5

  The caption, if any.

• optional string user_id = 6

  The user associated with this picture, if any.

• optional uint32 keg_id = 7

  The keg associated with this picture, if any.

• optional uint32 session_id = 8

  The session associated with this picture, if any.

• optional uint32 drink_id = 9

  The drink associated with this picture, if any.

• optional string thumbnail_url = 10

• optional string original_url = 11

• optional string small_resized_url = 13

A single instance of a Keg that was attached to the Kegbot.

Used in: Drink, KegTap, SyncResponse, SystemEvent

• required uint32 id = 1

  The unique identifier for this keg.

• required string keg_type = 2

  Shell type.

• required double remaining_volume_ml = 3

  Volume remaining in the keg, in milliliters.

• required double full_volume_ml = 4

  Initial volume.

• required double served_volume_ml = 5

  Served volume.

• required double spilled_volume_ml = 6

  Total portion of the original volume that was spoiled, in milliliters. Spilled volume is not attributed to any drink, but deducts from the keg total.

• required double percent_full = 7

  Percentage of the keg that remains, as a value between 0 and 100.

• optional string start_time = 8

  UTC time when the keg was started or tapped, as an ISO8061 UTC timestamp.

• optional string end_time = 9

  Local time when the keg was completed, as an ISO8061 UTC timestamp. This should be no sooner than the time of the most recent drink. If the keg's `status` is not 'offline', this value is undefined.

• optional bool online = 10

  True if the Keg is currently online.

• optional string description = 11

  The adminstrator's description of this keg.

• optional Beverage beverage = 12

  Beverage type.

• optional string illustration_url = 21

• optional string illustration_thumbnail_url = 22

• optional BeerType type = 13

• optional string type_id = 14

• optional uint32 size_id = 15

• optional KegSize size = 16

• optional string size_name = 17

• optional double size_volume_ml = 18

• optional double volume_ml_remain = 19

• optional double spilled_ml = 20

A common keg size.

Used in: Keg

• required uint32 id = 1

  The unique identifier for this keg size.

• required string name = 2

  The name of the size ("Half Barrel", "Pony keg", ...)

• required double volume_ml = 3

  The volume of the size, in milliliters.

Describes a tap which is available for pouring beer.

Used in: SyncResponse

• required uint32 id = 1

  The unique identifier for this tap.

• required string name = 2

  The name of the tap, a free-form string ("Main tap", "Wet bar", ...)

• optional string meter_name = 3

  The name of the flow meter assigned to this tap. Deprecated in favor of 'meter'

• optional FlowMeter meter = 12

  The currently-connected meter, if any.

• optional FlowToggle toggle = 13

  The currently-connected toggle, if any.

• optional ThermoSensor thermo_sensor = 14

  The currently-connected temperature sensor, if any.

• optional string relay_name = 4

  The relay name of the tap.

• optional double ml_per_tick = 5

  Size of each flowmeter tick, in milliliters.

• optional string description = 6

  A longer description of the tap.

• optional uint32 thermo_sensor_id = 8

  The temperature sensor for the tap, if any.

• optional ThermoLog last_temperature = 9

  The last temperature log, if any.

• optional uint32 current_keg_id = 10

  The Keg currently assigned to the tap. May be unset if there is no keg configured.

• optional Keg current_keg = 11

• optional uint32 sort_order = 15

• optional uint32 total = 1

  The total number of records available for this request.

• optional uint32 limit = 2

  The maximum number of records returned in this request.

• optional uint32 pos = 3

  The position of the first record returned, among "total".

Message used for recording a new drink on the backend.

• optional string tap_name = 1

  Name of the tap on which this drink was poured. This information is required, but this field may be omitted when the tap name is given elsewhere. (In the Kegweb API, the tap_name is part of the URL receiving the POST.)

• required uint32 ticks = 2

  The number of ticks, as reported by the flowmeter. Required.

• optional float volume_ml = 3

  The volume of the pour. If unspecified, the backend will use the current tap configuration to compute the pour's volume based on the value of "ticks".

• optional string username = 4

  The username responsible for the pour. If unspecified, this pour is treated as an anonymous pour.

• optional uint32 seconds_ago = 5

  The date and time of the pour, in seconds before "now", where "now" is the current time on the backend at the time the request is processed. If this field is unspecified, a default value of "0" (meaning "now") is assumed. This value is ignored if "record_date" is specified.

• optional string record_date = 6

  The absolute date and time of the pour, as an ISO8061 UTC timestamp. If specified and valid, this value supercedes any value given for "seconds_ago", which will be ignored.

• optional uint32 duration_seconds = 7

  The time taken, in seconds, to complete the pour.

• optional string auth_token = 8

  The authentication token used to pour the drink.

• optional bool spilled = 9

  If true, the pour is recorded as "spilled": no drink record will be generated, and all fields other than "tap_name" and the volume ("ticks", or "volume_ml" if given) are ignored. The volume will be added to the spilled total for the tap’s current keg.

• optional string shout = 10

  Optional message from the user about the pour.

• optional string tick_time_series = 11

  See Drink model.

Message used for recording a temperature sensor reading on the backend.

• required string sensor_name = 1

  The name of the sensor, as stored in the backend.

• required float temp_c = 2

  The observed temperature, in degress centigrade.

• optional string record_date = 3

  The date of the reading, as an ISO8601 UTC timestamp. If this field is unspecified, the record_date will be the current time on the backend at the time the request is processed.

A session is a group of drinks occuring within the same time window. Every poured drink will be associated with exactly one session.

Used in: Drink, SyncResponse, SystemEvent

• required uint32 id = 1

  The unique identifier for this session.

• required string start_time = 2

  The time this session was started, as an ISO8061 UTC timestamp.

• required string end_time = 3

  The time this session ended, as an ISO8061 UTC timestamp.

• required double volume_ml = 4

  Total volume poured during this session, in milliliters.

• optional string name = 5

  A name for this session.

• optional string slug = 6

  The slugified name of this session.

• optional string url = 7

  Canonical URL for this object.

• optional bool is_active = 8

  True if session is currently active.

Used in: SyncResponse

• optional string title = 1

• optional string server_version = 2

An administrator-defined sound file to play for certain pour events.

Used in: SyncResponse

• required string event_name = 1

  The name of this event.

• optional string event_predicate = 2

  The predicate for the event. Not currently used.

• required string sound_url = 3

  The URL for the sound file to play during this event.

• optional string user = 4

  A specific username that this event applies to. Not currently used.

• repeated Controller controllers = 1

  All configured controllers.

• repeated Drink drinks = 2

  Recently-poured drinks.

• repeated SystemEvent events = 3

  Recent system events.

• repeated Keg active_kegs = 4

  Kegs on tap.

• repeated FlowMeter meters = 5

  All configured meters.

• optional SiteInfo site_info = 6

  Site info.

• repeated SoundEvent sound_events = 7

  Sound events.

• repeated KegTap taps = 8

  All taps.

• repeated FlowToggle toggles = 9

  All toggles.

• optional Session active_session = 10

  Current session (if there is one).

• repeated User active_users = 11

  Currently-active users (if any).

Describes various events that happen in the system.

Used in: SyncResponse

• required uint32 id = 1

  The unqiue identifier for this event.

• required string kind = 2

  The kind of the event being reported. Current values: ``drink_poured``, ``session_started``, ``session_joined``, ``keg_tapped``, ``keg_ended``.

• required string time = 3

  The time of this event, as an ISO8061 UTC timestamp.

• optional uint32 drink_id = 4

  If a drink caused this event (as in ``drink_poured``, ``session_started``, and ``session_joined``), this field gives its id.

• optional uint32 keg_id = 5

  If this event relates to a specific keg (as in most events), this field gives its id.

• optional uint32 session_id = 6

  If this event relates to a specific session (as in ``drink_poured``, ``session_started``, and ``session_joined``), this field gives its id.

• optional string user_id = 7

  If this event relates to a specific user (as in ``drink_poured``, ``session_started``, and ``session_joined`` when the user is not anonymous), this field gives the user's id.

• optional Image image = 8

• optional User user = 9

• optional Drink drink = 10

• optional Keg keg = 11

• optional Session session = 12

A log entry for a temperature sensor.

Used in: KegTap, ThermoSensor

• required uint32 id = 1

  The unique identifier for this log entry.

• required uint32 sensor_id = 2

  The sensor id that produced this log entry.

• required double temperature_c = 3

  The temperature, in degrees C.

• required string time = 4

  The recording date, as an ISO8061 UTC timestamp.

A temperature sensor configured in the system.

Used in: KegTap

• required uint32 id = 1

  The unique identifier for this temperature sensor.

• required string sensor_name = 2

  The raw/unique name of the sensor.

• optional string nice_name = 3

  The friendly name for the sensor.

• optional ThermoLog last_log = 6

  The most recent recording for this sensor.

• optional double last_temp = 4

• optional string last_time = 5

A drinker registered in the kegbot system.

Used in: AuthenticationToken, Drink, SyncResponse, SystemEvent

• required string username = 1

  The user's unique username.

• optional string display_name = 13

  A non-unique "display" name, if available.

• optional Image image = 2

  The profile picture of the user. May be unset if the user does not have a profile picture.

• required bool is_active = 3

  True if the user is active. This value will be false for accounts which have been disabled by the admin.

• optional string first_name = 4

  The first name of the user. Not currently used.

• optional string last_name = 5

  The last name of the user. Not currently used.

• optional string email = 6

  The email address of the user. Only available to admin users.

• optional string password = 7

  The password of the user. Only available to admin users.

• optional bool is_staff = 8

  True if the user is a member of the system's staff. Only available to admin users.

• optional bool is_superuser = 9

  True if the user is an administrator. Only available to admin users.

• optional string last_login = 10

  UTC time for the user's last login, as ISO8061 string. Only available to admin users.

• optional string date_joined = 11

  UTC time for the user's registration, as ISO8061 string. Only available to admin users.

• optional string url = 12

  Canonical URL for this object.

• required string username = 1

  Desired username.

• required string email = 2

  User's e-mail address.

• optional string password = 3

  Initial password for logging in. If unspecified, the account will be registered with a random password, which can be e-mailed to the user.

• optional string gender = 4

  One of "male", "female".

• optional string twitter_name = 5

  Twitter username.