# API Reference

## Table of Contents

- [common.proto](#common-proto)


  - Messages
     - [BoolValue](#boolvalue)
     - [BytesValue](#bytesvalue)
     - [ChipBoolValue](#chipboolvalue)
     - [ChipIndex](#chipindex)
     - [ChipIntValue](#chipintvalue)
     - [ChipSintValue](#chipsintvalue)
     - [ChipStringValue](#chipstringvalue)
     - [ChipUintValue](#chipuintvalue)
     - [Date](#date)
     - [Empty](#empty)
     - [FloatValue](#floatvalue)
     - [InetAddress](#inetaddress)
     - [Int32Value](#int32value)
     - [Int64Value](#int64value)
     - [LogLine](#logline)
     - [SInt32Value](#sint32value)
     - [SInt64Value](#sint64value)
     - [StringList](#stringlist)
     - [StringValue](#stringvalue)
     - [UInt32Value](#uint32value)
     - [UInt64Value](#uint64value)
     - [Version](#version)
  



- [control.proto](#control-proto)

  - Services
     - [ControlInfo](#controlinfo)
     - [DataStream](#datastream)
     - [Trigger](#trigger)
  


  - Messages
     - [ChipBoardInfo](#chipboardinfo)
     - [DataStreamPathList](#datastreampathlist)
     - [FpgaRegReadReq](#fpgaregreadreq)
     - [FpgaRegRpl](#fpgaregrpl)
     - [FpgaRegWriteReq](#fpgaregwritereq)
     - [LinkConfig](#linkconfig)
     - [LinkConfigList](#linkconfiglist)
     - [OpticalLinkConfig](#opticallinkconfig)
     - [PixelChipInfo](#pixelchipinfo)
     - [PixelChipList](#pixelchiplist)
     - [RegMapAction](#regmapaction)
     - [RegMapActionList](#regmapactionlist)
     - [RegMapValue](#regmapvalue)
     - [RegMapValueList](#regmapvaluelist)
     - [ShutdownRequest](#shutdownrequest)
     - [TriggerConfig](#triggerconfig)
     - [TriggerStatus](#triggerstatus)
     - [UpdateCall](#updatecall)
     - [UpdateResponse](#updateresponse)
     - [XGbeConfig](#xgbeconfig)
     - [XGbeLinkConfig](#xgbelinkconfig)
  


  - Enums
     - [BusyOut](#busyout)
     - [DataStreamPath](#datastreampath)
     - [PixelChipType](#pixelchiptype)
     - [RegMapOp](#regmapop)
     - [ShutdownAction](#shutdownaction)
     - [ShutterIn](#shutterin)
     - [T0SyncIn](#t0syncin)
     - [UpdateAction](#updateaction)
     - [UpdateResult](#updateresult)
  


- [pixelchip.proto](#pixelchip-proto)

  - Services
     - [Medipix4](#medipix4)
     - [Timepix4](#timepix4)
  


  - Messages
     - [DacValue](#dacvalue)
     - [DacValueList](#dacvaluelist)
     - [ReadRegReply](#readregreply)
     - [ReadRegRequest](#readregrequest)
     - [SimpleReadReply](#simplereadreply)
     - [SimpleReadRequest](#simplereadrequest)
     - [SimpleWriteRequest](#simplewriterequest)
     - [Tpx4AdcConfig](#tpx4adcconfig)
     - [Tpx4AdcRequest](#tpx4adcrequest)
     - [Tpx4BroadcastPixelConfig](#tpx4broadcastpixelconfig)
     - [Tpx4BroadcastSPGroupConfig](#tpx4broadcastspgroupconfig)
     - [Tpx4BurstReadoutOptions](#tpx4burstreadoutoptions)
     - [Tpx4ColumnAddress](#tpx4columnaddress)
     - [Tpx4Packets](#tpx4packets)
     - [Tpx4PartialPixelConfig](#tpx4partialpixelconfig)
     - [Tpx4PartialPixelConfig-Tpx4PixelPart](#tpx4partialpixelconfigtpx4pixelpart)
     - [Tpx4PartialSPGroupConfig](#tpx4partialspgroupconfig)
     - [Tpx4PartialSPGroupConfig-Tpx4SPGroupPart](#tpx4partialspgroupconfigtpx4spgrouppart)
     - [Tpx4PixelConfig](#tpx4pixelconfig)
     - [Tpx4ReadoutConfig](#tpx4readoutconfig)
     - [Tpx4ReadoutOptions](#tpx4readoutoptions)
     - [Tpx4SPGroupConfig](#tpx4spgroupconfig)
     - [Tpx4ShutterConfig](#tpx4shutterconfig)
     - [Tpx4StatusMonConfig](#tpx4statusmonconfig)
     - [Tpx4TestPulseColumnEnable](#tpx4testpulsecolumnenable)
     - [Tpx4TestPulseConfig](#tpx4testpulseconfig)
     - [Tpx4ToAConfig](#tpx4toaconfig)
     - [WriteRegReply](#writeregreply)
     - [WriteRegRequest](#writeregrequest)
  


  - Enums
     - [Tpx4AnalogFrontEndMode](#tpx4analogfrontendmode)
     - [Tpx4Dac](#tpx4dac)
     - [Tpx4DacOut](#tpx4dacout)
     - [Tpx4Gain](#tpx4gain)
     - [Tpx4Half](#tpx4half)
     - [Tpx4ReadoutOp](#tpx4readoutop)
     - [Tpx4ShutterInput](#tpx4shutterinput)
     - [Tpx4ShutterMode](#tpx4shuttermode)
     - [Tpx4SignalSelect](#tpx4signalselect)
  


- [peripheral.proto](#peripheral-proto)

  - Services
     - [Peripheral](#peripheral)
  


  - Messages
     - [DataPoint](#datapoint)
     - [DataPointList](#datapointlist)
     - [DeviceStatus](#devicestatus)
     - [DeviceStatusList](#devicestatuslist)
     - [MetaData](#metadata)
     - [MetaDataList](#metadatalist)
     - [Value](#value)
  


  - Enums
     - [DataRole](#datarole)
     - [ValueType](#valuetype)
  


- [daq.proto](#daq-proto)

  - Services
     - [Daq](#daq)
  


  - Messages
     - [Consumer](#consumer)
     - [ConsumerStats](#consumerstats)
     - [DaqConfig](#daqconfig)
     - [DaqStatus](#daqstatus)
     - [EnableMessage](#enablemessage)
     - [FileDestination](#filedestination)
     - [PipelineConfig](#pipelineconfig)
     - [Receiver](#receiver)
     - [RunProperties](#runproperties)
     - [Stream](#stream)
     - [StreamStats](#streamstats)
     - [UserDataFrame](#userdataframe)
  



- [Scalar Value Types](#scalar-value-types)



---

## common.proto



### Messages



#### BoolValue

Boolean wrapper.


| Field | Type | Description |
| ----- | ---- | ----------- |
| value | [ bool](#bool) | Boolean value |






#### BytesValue




| Field | Type | Description |
| ----- | ---- | ----------- |
| value | [ bytes](#bytes) | Blob value |






#### ChipBoolValue

A boolean value bound to a specific chip.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ uint32](#uint32) | none |
| value | [ bool](#bool) | none |






#### ChipIndex

ChipIndex wrapper.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ uint32](#uint32) | Chip index |






#### ChipIntValue

A int value bound to a specific chip.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ uint32](#uint32) | none |
| value | [ int32](#int32) | none |






#### ChipSintValue

A signed int value bound to a specific chip.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ uint32](#uint32) | none |
| value | [ sint32](#sint32) | none |






#### ChipStringValue

A string value bound to a specific chip.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ uint32](#uint32) | none |
| value | [ string](#string) | none |






#### ChipUintValue

A unsigned int value bound to a specific chip.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ uint32](#uint32) | none |
| value | [ uint32](#uint32) | none |






#### Date

A date.


| Field | Type | Description |
| ----- | ---- | ----------- |
| year | [ uint32](#uint32) | Year, complete, e.g. 2019 |
| month | [ uint32](#uint32) | Month 1-12 |
| day | [ uint32](#uint32) | Day 1-31 |






#### Empty

Empty message.





#### FloatValue




| Field | Type | Description |
| ----- | ---- | ----------- |
| value | [ float](#float) | Floating point value |






#### InetAddress

Abstraction of an internet address.


| Field | Type | Description |
| ----- | ---- | ----------- |
| host | [ string](#string) | none |
| port | [ uint32](#uint32) | none |






#### Int32Value

Int32 wrapper.


| Field | Type | Description |
| ----- | ---- | ----------- |
| value | [ int32](#int32) | Integer value |






#### Int64Value

Int64 wrapper.


| Field | Type | Description |
| ----- | ---- | ----------- |
| value | [ int64](#int64) | Integer value, 64 bits |






#### LogLine

A single line of logging.


| Field | Type | Description |
| ----- | ---- | ----------- |
| text | [ string](#string) | none |






#### SInt32Value

Signed int32 wrapper.


| Field | Type | Description |
| ----- | ---- | ----------- |
| value | [ sint32](#sint32) | Signed Integer value |






#### SInt64Value

Signed int64 wrapper.


| Field | Type | Description |
| ----- | ---- | ----------- |
| value | [ sint64](#sint64) | Signed Integer value, 64 bits |






#### StringList

A list of strings.


| Field | Type | Description |
| ----- | ---- | ----------- |
| items | [repeated string](#string) | String items |






#### StringValue

A String wrapper.


| Field | Type | Description |
| ----- | ---- | ----------- |
| value | [ string](#string) | String value |






#### UInt32Value

Unsigned int32 wrapper.


| Field | Type | Description |
| ----- | ---- | ----------- |
| value | [ uint32](#uint32) | Unsigned integer value |






#### UInt64Value

Unsigned int64 wrapper.


| Field | Type | Description |
| ----- | ---- | ----------- |
| value | [ uint64](#uint64) | Unsigned integer value, 64 bits |






#### Version

Version message for querying service versions.


| Field | Type | Description |
| ----- | ---- | ----------- |
| product | [ string](#string) | Product name |
| majr | [ int32](#int32) | Major version number |
| minr | [ int32](#int32) | Minor version number |
| patch | [ int32](#int32) | Patch number |
| build\_date | [ string](#string) | Build date (converted to string) |
| commit\_info | [ string](#string) | Commit information string (usually GIT information) |










---

## control.proto



### Services

#### ControlInfo

High level control and info service for SPIDR4.

| Methods|
| ------ |
| <pre>GetVersion([Empty](#empty)) [Version](#version)</pre> Request version of the SPIDR4 control software.<br> Note that this is different from the firmware version. <br> <br> |
| <pre>GetFirmwareVersion([Empty](#empty)) [Version](#version)</pre> Returns the base firmware version. <br> <br> |
| <pre>GetSerial([Empty](#empty)) [Int64Value](#int64value)</pre> Request the serial number of this SPIDR4 module. <br> <br> |
| <pre>Shutdown([ShutdownRequest](#shutdownrequest)) [Empty](#empty)</pre> Shutdown the service or device. <br> <br> |
| <pre>SysConfig([StringValue](#stringvalue)) [StringValue](#stringvalue)</pre> System configuration task. Expert call! <br> <br> |
| <pre>SysUpdate([UpdateCall](#updatecall)) [UpdateResponse](#updateresponse)</pre> System update task. Expert call! <br> <br> |
| <pre>PowerDisable([Empty](#empty)) [Empty](#empty)</pre> Panic power disable for the chip.<br> Call this if things go horribly wrong. This state is unrecoverable, and the control must be restarted in order to restore the state. <br> <br> |
| <pre>GetPixelChipInfo([Empty](#empty)) [PixelChipList](#pixelchiplist)</pre> Request information about the chips connected to this SPIDR4 board. <br> <br> |
| <pre>GetChipBoardInfo([Empty](#empty)) [ChipBoardInfo](#chipboardinfo)</pre> Request information about the board. <br> <br> |
| <pre>ResetPixelChips([Empty](#empty)) [Empty](#empty)</pre> Reset all pixel chips and run initialization scripts.<br> This will interfere with any ongoing on-chip operations.<br> TODO: move this to the pixelchip service? <br> <br> |
| <pre>RegMapAccess([RegMapActionList](#regmapactionlist)) [RegMapValueList](#regmapvaluelist)</pre> Low level access to the register map.<br><br>RegMap access allows multiple operations to be executed on the registers at once, therefore the RegMapRequests consists of multiple RegMapAction objects.<br> Each action can be either read, write or modify (=masked write).<br> Bulk reading / writing is possible by creating a multiple RegMapAction items in the RegMapRequest's actions list. <br><br> All addresses are physical addresses, as provided in the reference documentation and thus must be located at multiples of four. Trying to access registers outside of the SPIDR4 firmware register map or at an illegal offset will cause an error response. <br> <br> |
| <pre>FpgaRegWrite([FpgaRegWriteReq](#fpgaregwritereq)) [FpgaRegRpl](#fpgaregrpl)</pre> Writes a register in the FPGA fabric from an offset.<br> See register map documentation for exact offsets.<br> Low level FPGA command, using this could cause undefined behavior and in extreme cases malfunction. Use with care. <br> <br> |
| <pre>FpgaRegRead([FpgaRegReadReq](#fpgaregreadreq)) [FpgaRegRpl](#fpgaregrpl)</pre> Reads a register in the FPGA fabric from an offset.<br> See register map documentation for exact offsets.<br> Low level FPGA command, using this could cause undefined behavior and in extreme cases malfunction. Use with care. <br> <br> |
| <pre>GetLogging([Empty](#empty)) [LogLine](#logline)</pre> Returns console logging as a stream. <br> <br> |


#### DataStream

DataStream is a high-level control interface for configuring the path of the output of the pixelchip. 

There are 3 major paths which have all a separate configuration command:
<ul>
<li>Slow control (Use ConfigSlowControl)</li>
<li>10 Gigabit Ethernet (Use ConfigXGbe)</li>
<li>Optical links (Use ConfigOptical)</li>
</ul> 
Each specific method will configure all elements in the output chain such that the PixelChip is able to send data through the configured data path. This includes enabling the channels on the pixel chip itself, but also includes configuring the IP settings when 10GbE is selected. 

Once configured a final Enable command must be given to enable the last elements in the chain.

<b>Note:</b> For Timepix4 only the optical datapath allows for full-speed readout.

| Methods|
| ------ |
| <pre>ConfigXGbe([XGbeConfig](#xgbeconfig)) [Empty](#empty)</pre> Configures the 10GbE Ethernet.<br> Can only be called if not enabled. <br> <br> |
| <pre>ConfigOptical([OpticalLinkConfig](#opticallinkconfig)) [Empty](#empty)</pre> Configures direct optical links.<br> Can only be called if not enabled. <br> <br> |
| <pre>ConfigSlowControl([ChipIndex](#chipindex)) [Empty](#empty)</pre> Configures the DAQ over slow-control.<br> (For the future, for now it does not do anything) <br> <br> |
| <pre>ConfigNone([ChipIndex](#chipindex)) [Empty](#empty)</pre> De-configure the given chip. <br> <br> |
| <pre>GetChipCapabilities([ChipIndex](#chipindex)) [DataStreamPathList](#datastreampathlist)</pre> Returns the capabilities for the given chip. <br> <br> |
| <pre>GetConfig([Empty](#empty)) [LinkConfigList](#linkconfiglist)</pre> Returns the current configuration. <br> <br> |


#### Trigger

Shutter configuration and control service.

Note*: This is the SPIDR4 shutter system!

To propagate this to the pixelchip you must enable external input on the chip itself.<br>
For example, for the shutter on a Timepix4 you must set: <br>
Tpx4ShutterConfig.mode = TPX4_SHUTTER_MODE_MANUAL<br>
Tpx4ShutterConfig.input = TPX4_SHUTTER_INPUT_PAD

| Methods|
| ------ |
| <pre>Enable([Empty](#empty)) [Empty](#empty)</pre> Enable the trigger circuit. <br><br>Without this call the SPIDR4 will not generate shutter or T0 Syncs. <br> <br> |
| <pre>Disable([Empty](#empty)) [Empty](#empty)</pre> Disable the trigger circuit. <br> <br> |
| <pre>GetStatus([Empty](#empty)) [TriggerStatus](#triggerstatus)</pre> Return shutter information. <br> <br> |
| <pre>SetConfig([TriggerConfig](#triggerconfig)) [Empty](#empty)</pre> Configure the shutter. <br> <br> |
| <pre>StartAutoShutter([Empty](#empty)) [Empty](#empty)</pre> Start the auto-shutter<br> (when TriggerConfig.shutter_input == SHUTTER_IN_AUTO_GEN). <br> <br> |
| <pre>StopAutoShutter([Empty](#empty)) [Empty](#empty)</pre> Stop the auto-shutter<br> (when TriggerConfig.shutter_input == SHUTTER_IN_AUTO_GEN). <br> <br> |
| <pre>ShutterOpen([Empty](#empty)) [Empty](#empty)</pre> Open the shutter<br> (when TriggerConfig.shutter_input == SHUTTER_IN_SOFTWARE). <br> <br> |
| <pre>ShutterClose([Empty](#empty)) [Empty](#empty)</pre> Close the shutter<br> (when TriggerConfig.shutter_input == SHUTTER_IN_SOFTWARE). <br> <br> |
| <pre>ResetShutterCounter([Empty](#empty)) [Empty](#empty)</pre> Reset the shutter counter. <br> <br> |
| <pre>T0Sync([Empty](#empty)) [Empty](#empty)</pre> Generate a 100 us T0 Sync pulse<br> (when TriggerConfig.t0sync_input == T0SYNC_IN_SOFTWARE). <br> <br> |
| <pre>ResetT0Counter([Empty](#empty)) [Empty](#empty)</pre> Reset the T0 Sync counter <br> <br> |






### Messages



#### ChipBoardInfo

Information about the connected chip-board.


| Field | Type | Description |
| ----- | ---- | ----------- |
| type | [ string](#string) | Type of the board, configuration file specified type name |
| serial | [ string](#string) | Serial of the board, confguration file specified |






#### DataStreamPathList

List of DataStreamPath items.


| Field | Type | Description |
| ----- | ---- | ----------- |
| items | [repeated DataStreamPath](#datastreampath) | none |






#### FpgaRegReadReq

FPGA register read request.


| Field | Type | Description |
| ----- | ---- | ----------- |
| offset | [ uint32](#uint32) | Register offset from base address |






#### FpgaRegRpl




| Field | Type | Description |
| ----- | ---- | ----------- |
| offset | [ uint32](#uint32) | Register offset from base address |
| value | [ uint32](#uint32) | Read-back value |






#### FpgaRegWriteReq

FPGA register write request.


| Field | Type | Description |
| ----- | ---- | ----------- |
| offset | [ uint32](#uint32) | Register offset from base address |
| value | [ uint32](#uint32) | Value to write |
| mask | [ uint32](#uint32) | Mask, is optional.<br> When used, bits are changed only where mask bits are set. Otherwise the entire value is written to the register. |






#### LinkConfig




| Field | Type | Description |
| ----- | ---- | ----------- |
| path | [ DataStreamPath](#datastreampath) | The stream path for this link config.<br> Also defines which entry of link will be filled. |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) link.xgbe | [ XGbeConfig](#xgbeconfig) | Set for DataStreamPath = DSPATH_XGBE or DSPATH_2XGBE |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) link.optical | [ OpticalLinkConfig](#opticallinkconfig) | Set for DataStreamPath = DSPATH_OPTICAL |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) link.sc | [ ChipIndex](#chipindex) | Set for DataStreamPath = DSPATH_SLOW_CONTROL |






#### LinkConfigList

List of Link configurations.


| Field | Type | Description |
| ----- | ---- | ----------- |
| items | [repeated LinkConfig](#linkconfig) | For each item, a link configuration |






#### OpticalLinkConfig

Configures the optical path.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ uint32](#uint32) | Chip index to configure |
| channels | [ uint32](#uint32) | The channels you wish to enable on the chip.<br> Bit 0 - First channel<br> Bit 1 - Second channel, etc...<br> For TPX4: <ul> <li>Bit 0 = top0</li> <li>Bit 7 = top7</li> <li>Bit 8 = bot0</li> <li>Bit 15 = bot7</li> <li>Bit &gt;15 = not valid</li> </ul> Leave empty for 'all available'.<br> To disable from outputting data chip, use configNone() grpc call. |
| link\_speed | [ float](#float) | Set the link-speed for all selected channels, in MHz.<br> If the link_speed is not possible an error will be returned.<br> Depends on the specific chip.<br> For Timepix4: <ul> <li>10240 MHz (uses 320 MHz mode)</li> <li>5120 MHz</li> <li>2560 MHz</li> <li>1280 MHz</li> <li>640 MHz</li> <li>320 MHz</li> <li>160 MHz</li> <li>80 MHz</li> <li>40 MHz</li> </ul> |






#### PixelChipInfo

Generic pixelchip information.


| Field | Type | Description |
| ----- | ---- | ----------- |
| type | [ PixelChipType](#pixelchiptype) | The type of the pixel chip |
| chip\_id | [ uint32](#uint32) | The ID of the chip |
| idx | [ uint32](#uint32) | Chip index on the board, used as primary identifier |
| revision | [ int32](#int32) | Chip revision |






#### PixelChipList

List of pixelchips information.


| Field | Type | Description |
| ----- | ---- | ----------- |
| items | [repeated PixelChipInfo](#pixelchipinfo) | A list of PixelChipInfo elements |






#### RegMapAction

Register map operation.


| Field | Type | Description |
| ----- | ---- | ----------- |
| oper | [ RegMapOp](#regmapop) | Operation to perform |
| addr | [ uint32](#uint32) | Physical address on the bus |
| value | [ uint32](#uint32) | Value to write (not used with READ) |
| mask | [ uint32](#uint32) | Mask to apply (only used with MODIFY and MODIFY_READ) |






#### RegMapActionList

Request a number of regmap register operations.


| Field | Type | Description |
| ----- | ---- | ----------- |
| items | [repeated RegMapAction](#regmapaction) | Register map action items |






#### RegMapValue

SPIDR4 register map value reading.


| Field | Type | Description |
| ----- | ---- | ----------- |
| addr | [ uint32](#uint32) | Register address |
| value | [ uint32](#uint32) | Register value |






#### RegMapValueList

A reply with zero or more register map value readings.


| Field | Type | Description |
| ----- | ---- | ----------- |
| items | [repeated RegMapValue](#regmapvalue) | none |






#### ShutdownRequest

Shutdown request


| Field | Type | Description |
| ----- | ---- | ----------- |
| action | [ ShutdownAction](#shutdownaction) | Specific shutdown action to execute |






#### TriggerConfig

Trigger block configuration.


| Field | Type | Description |
| ----- | ---- | ----------- |
| shutter\_input | [ ShutterIn](#shutterin) | Define the shutter input |
| t0\_input | [ T0SyncIn](#t0syncin) | Define the T0 input. |
| busy\_output | [ BusyOut](#busyout) | What signal to put on the busy out. |
| auto\_shutter\_open\_us | [ float](#float) | Set shutter open duration in microseconds. Granularity is 25 ns.<br> Choose either auto_shutter_open_us or auto_shutter_open.<br> Only when useful when using AUTO_GEN or AUTO_GEN_EXT_START. |
| auto\_shutter\_close\_us | [ float](#float) | Shutter close duration in microseconds. Granularity is 25 ns.<br> Choose either auto_shutter_close_us or auto_shutter_close<br> Only when useful when using AUTO_GEN or AUTO_GEN_EXT_START. |
| shutter\_count | [ uint32](#uint32) | Number of shutters to generate. Don't set or set to 0 for infinite. |
| auto\_shutter\_open | [ uint32](#uint32) | Set shutter open duration in 25 ns clocks.<br> Choose either auto_shutter_open_us or auto_shutter_open.<br> Only when useful when using AUTO_GEN or AUTO_GEN_EXT_START. |
| auto\_shutter\_close | [ uint32](#uint32) | Shutter close duration in in 25 ns clocks..<br> Choose either auto_shutter_close_us or auto_shutter_close<br> Only when useful when using AUTO_GEN or AUTO_GEN_EXT_START. |






#### TriggerStatus

Returns the shutter status.


| Field | Type | Description |
| ----- | ---- | ----------- |
| enabled | [ bool](#bool) | Whether or not the trigger circuit is enabled. |
| config | [ TriggerConfig](#triggerconfig) | Current trigger config. |
| auto\_shutter\_busy | [ bool](#bool) | Whether or not the auto-shutter is busy |
| software\_shutter\_open | [ bool](#bool) | Whether or not the software shutter is open |
| shutter\_counter | [ uint32](#uint32) | Number of shutters output |
| t0sync\_counter | [ uint32](#uint32) | Number of T0 Syncs output |






#### UpdateCall

Expert function, do not use!


| Field | Type | Description |
| ----- | ---- | ----------- |
| action | [ UpdateAction](#updateaction) | none |
| sequence | [ uint32](#uint32) | none |
| details | [ string](#string) | none |
| data | [ bytes](#bytes) | none |






#### UpdateResponse

Expert function, do not use!


| Field | Type | Description |
| ----- | ---- | ----------- |
| result | [ UpdateResult](#updateresult) | none |
| sequence | [ uint32](#uint32) | none |
| details | [ string](#string) | none |






#### XGbeConfig

Configure data stream Via 10 Gbe Ethernet


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ uint32](#uint32) | Chip index |
| primary | [ XGbeLinkConfig](#xgbelinkconfig) | Primary link configuration |
| secondary | [ XGbeLinkConfig](#xgbelinkconfig) | Secondary link configuration. Don't set if you do not want to use a secondary link. Make sure the primary.port != secondary.port |
| ignoreLockState | [ bool](#bool) | For diagnostics only! Don't set! |






#### XGbeLinkConfig

10GbE link configuration.<br>
IP addresses are strings formatted as #.#.#.#, e.g. 192.168.1.1 <br>
MAC addresses are strings formatted as xx:xx:xx:xx:xx, e.g 00:02:FF:EE:00:11


| Field | Type | Description |
| ----- | ---- | ----------- |
| source\_ip | [ string](#string) | source IP address |
| dest\_ip | [ string](#string) | destination IP address |
| dest\_mac | [ string](#string) | destination MAC address (default = ff:ff:ff:ff:ff:ff) |
| port | [ uint32](#uint32) | Base port, default: 43210 for primary and 43211 for secondary.<br> For single 10GbE link configurations the source and destination port will be 'port' for top and 'port+1' for bottom, unless a second port number is provided in the most-significant 2 bytes of 'port', which will be used for bottom (e.g. set both port numbers to the same value if top and bottom data is to be received on one port).<br> For dual 10GbE link the primary port will be used for top and the secondary port for bottom. |








### Enums


#### BusyOut

The busy-out can be routed to the external IO to indicate the state of the trigger logic.

| Name | Number | Description |
| ---- | ------ | ----------- |
| BUSY_OUT_NONE | 0 | No busy output (output will be low) |
| BUSY_OUT_AUTO_SHUTTER_BUSY | 1 | The auto_shutter_busy signal. |
| BUSY_OUT_T0_SYNC | 2 | Direct copy the T0Sync signal |
| BUSY_OUT_SHUTTER | 3 | Direct copy the SHUTTER signal |




#### DataStreamPath

DataStreamPath defines the way a link is configured.

| Name | Number | Description |
| ---- | ------ | ----------- |
| _DSPATH_NONE | 0 | Don't use |
| DSPATH_SLOW_CONTROL | 1 | none |
| DSPATH_XGBE | 2 | 10GbE data path |
| DSPATH_2XGBE | 4 | 2x 10GbE data path |
| DSPATH_OPTICAL | 8 | Optical connection data path (FireFly devices) |




#### PixelChipType

Pixelchip type identifier.

| Name | Number | Description |
| ---- | ------ | ----------- |
| UNKNOWN | 0 | Unknown chip type |
| TIMEPIX4 | 1 | Chip is a Timepix4 chip.<br> Use of Timepix4 service is possible with this chip type only. |
| MEDIPIX4 | 2 | Chip is a Medipix4 chip.<br> Use of Medipix4 service is possible with this chip type only. |




#### RegMapOp

Type of operation to execute on the register map.

| Name | Number | Description |
| ---- | ------ | ----------- |
| READ | 0 | Read a value from a register |
| WRITE | 1 | Write a value to a register |
| WRITE_READ | 2 | Write a value to a register, and read it back |
| MODIFY | 3 | Modify the register using the mask:<br> (\*addr) = ((\*addr) & ~mask) \| (value & mask) |
| MODIFY_READ | 4 | Same as MODIFY, but also reads back the result |




#### ShutdownAction

Allowed shutdown actions

| Name | Number | Description |
| ---- | ------ | ----------- |
| STOP_SERVICE | 0 | Stop RPC service |
| RESTART_SERVICE | 1 | Restart RPC service |
| SHUTDOWN | 2 | Power off SPIDR4 control board |
| REBOOT | 3 | Reboot the SPIDR4 board |




#### ShutterIn

Shutter Input

| Name | Number | Description |
| ---- | ------ | ----------- |
| SHUTTER_IN_SOFTWARE | 0 | Through software (use Trigger::ShutterOpen() and Trigger::ShutterClose()) |
| SHUTTER_IN_AUTO_GEN | 1 | Using the auto-generator (use Trigger:StartAutoShutter() ) |
| SHUTTER_IN_EXTERNAL | 2 | Using the external input (high->open, lo->close) |
| SHUTTER_IN_AUTO_GEN_EXT_START | 3 | Using the auto-generator.<br> Started on the rising edge of the external input. |




#### T0SyncIn



| Name | Number | Description |
| ---- | ------ | ----------- |
| T0SYNC_IN_SOFTWARE | 0 | Through software, use Trigger::T0Sync() |
| T0SYNC_IN_EXTERNAL | 1 | Using external input. |




#### UpdateAction

Expert function, do not use!

| Name | Number | Description |
| ---- | ------ | ----------- |
| RESET | 0 | none |
| TRANSFER | 1 | none |
| RESULT | 2 | none |




#### UpdateResult

Expert function, do not use!

| Name | Number | Description |
| ---- | ------ | ----------- |
| SUCCESS | 0 | none |
| ERROR_SEQUENCE | 10 | none |
| ERROR_WRITING | 11 | none |








---

## pixelchip.proto



### Services

#### Medipix4

Medipix4 chip controls.

| Methods|
| ------ |
| <pre>ReadReg([ReadRegRequest](#readregrequest)) [ReadRegReply](#readregreply)</pre> Read register request. <br> <br> |
| <pre>WriteReg([WriteRegRequest](#writeregrequest)) [WriteRegReply](#writeregreply)</pre> Write register request. <br> <br> |
| <pre>SimpleRead([SimpleReadRequest](#simplereadrequest)) [SimpleReadReply](#simplereadreply)</pre> Simple register read, for registers up to 32 bit.<br> Converts the entire register value to a integer.<br><br>For example, getting the chip ID:<br> print( "ChipId: %08x" % tpx4stub.SimpleRead(SimpleReadRequest(idx=0, addr=0x9000)).val ) <br> <br> |
| <pre>SimpleWrite([SimpleWriteRequest](#simplewriterequest)) [Empty](#empty)</pre> Simple register write, for registers up to 32 bit.<br><br>For example, setting a the DAC_VbiasADC:<br> tpx4stub.SimpleWrite( SimpleWriteRequest(idx=0, addr=0xA000, val=128) ) <br> <br> |


#### Timepix4

Timepix chip controls.

| Methods|
| ------ |
| <pre>Reset([Empty](#empty)) [Empty](#empty)</pre> Resets the Pixel matrix. <br> <br> |
| <pre>ReadReg([ReadRegRequest](#readregrequest)) [ReadRegReply](#readregreply)</pre> Read register request. <br> <br> |
| <pre>WriteReg([WriteRegRequest](#writeregrequest)) [WriteRegReply](#writeregreply)</pre> Write register request. <br> <br> |
| <pre>SimpleRead([SimpleReadRequest](#simplereadrequest)) [SimpleReadReply](#simplereadreply)</pre> Simple register read, for registers up to 32 bit.<br> Converts the entire register value to a integer.<br><br>For example, getting the chip ID:<br> print( "ChipId: %08x" % tpx4stub.SimpleRead(SimpleReadRequest(idx=0, addr=0x9000)).val ) <br> <br> |
| <pre>SimpleWrite([SimpleWriteRequest](#simplewriterequest)) [Empty](#empty)</pre> Simple register write, for registers up to 32 bit.<br><br>For example, setting a the DAC_VbiasADC:<br> tpx4stub.SimpleWrite( SimpleWriteRequest(idx=0, addr=0xA000, val=128) ) <br> <br> |
| <pre>RunScript([ChipStringValue](#chipstringvalue)) [Empty](#empty)</pre> Runs a configuration script (.adat).<br> All scripts must be located in the default script directory on the control SD-card, most likely this is /etc/control/scripts.<br> The string value must be the filename without extension, or directory. e.g. the file it will try to find is:<br> /etc/control/scripts/<provided-name>.adat <br> <br> |
| <pre>SetDacs([DacValueList](#dacvaluelist)) [Empty](#empty)</pre> Set one or more DACs.<br> If a DAC value is out of range an error will be returned. <br> <br> |
| <pre>GetDacs([ChipIndex](#chipindex)) [DacValueList](#dacvaluelist)</pre> Get all DAC values for specified chip. <br> <br> |
| <pre>ConfigAdc([Tpx4AdcConfig](#tpx4adcconfig)) [Empty](#empty)</pre> Configure the ADC. <br> <br> |
| <pre>AdcRead([Tpx4AdcRequest](#tpx4adcrequest)) [FloatValue](#floatvalue)</pre> Starts and returns an ADC conversion.<br> Note that the ADC is connected to the DAC_OUT. As such any signal selected on this line will be sampled. <br> <br> |
| <pre>PixelMatrixReset([ChipIndex](#chipindex)) [Empty](#empty)</pre> Resets the entire pixel matrix to its defaults. <br> <br> |
| <pre>ConfigPixels([Tpx4PixelConfig](#tpx4pixelconfig)) [Empty](#empty)</pre> Sets the pixel configuration of the entire chip. <pre> Expects 512 x 448 8-bit pixel configurations, order:<br> For each Half(top, bottom) <br> For each colum (0..223) <br> For each SPGroup (0..15) <br> For each SuperPixel (0..3) <br> Write 8 x Pixel config (8 bits)<br> See: https://timepix4.web.cern.ch/timepix4/timepix4/ChipOperation/configuration_and_accessing_the_matrix.html#id1 </pre> The first pixel written is the pixel 0 of superpixel 0, of SPgroup 0 of column 0, of the bottom half.<br> The last pixel written is pixel 7 of superpixel 3 of SPgroup 15 of column 223 of the top half. <br> <br> |
| <pre>ConfigGetPixels([ChipIndex](#chipindex)) [Tpx4PixelConfig](#tpx4pixelconfig)</pre> Reads out the pixel configuration. Order is same as ConfigPixels. <br> <br> |
| <pre>ConfigPixelsPartial([Tpx4PartialPixelConfig](#tpx4partialpixelconfig)) [Empty](#empty)</pre> Partially configures the pixel matrix. Either using columns or superpixel addressing.<br><br><b>TODO</b> <br> <br> |
| <pre>ConfigPixelsBroadcast([Tpx4BroadcastPixelConfig](#tpx4broadcastpixelconfig)) [Empty](#empty)</pre> Broadcast the pixel configuration per column. <br> When no specific columns are provided the column configuration will be set to all column top and bottom.<br> Note that the broadcast only consists of pixel configurations for one SPGroup. It will be applied to ALL SPGroups in that column!<br> Expects 32 bytes in 'pixels'.<br> Order: <br> For each SuperPixel (0..3) <br> Write 8 x Pixel config (8 bits) <br> <br> |
| <pre>ConfigSPGroups([Tpx4SPGroupConfig](#tpx4spgroupconfig)) [Empty](#empty)</pre> Configures all SPGroups. <br> <pre> Expects 32 x 224 24-bit SPGroup configurations, ingroups of 3 bytes per configuration. <br> Big-endian encoded. Order: <br> For each half (top, bottom): <br> For each column (0..223): <br> For each SPGroup (0..15): <br> Write SPGroup config (24 bits) <br> See: https://timepix4.web.cern.ch/timepix4/timepix4/ChipOperation/configuration_and_accessing_the_matrix.html#id2 </pre> <br> <br> |
| <pre>ConfigGetSPGroups([ChipIndex](#chipindex)) [Tpx4SPGroupConfig](#tpx4spgroupconfig)</pre> Reads out the pixel group configuration.<br> Order is the same as ConfigSPGRoups. <br> <br> |
| <pre>ConfigSPGroupsBroadcast([Tpx4BroadcastSPGroupConfig](#tpx4broadcastspgroupconfig)) [Empty](#empty)</pre> Broadcast SPGroup config to to all or selected columns.<br> When no spefic columns are provided the column configuration will be set to all column top and bottom.<br><br>Expects 16 SPGroup configurations (384 bits) <br> <br> |
| <pre>ConfigSPGroupsPartial([Tpx4PartialSPGroupConfig](#tpx4partialspgroupconfig)) [Empty](#empty)</pre> Set SPGroup config to selected SPGroups.<br> For each item you must specify the half (top/bottom), the column (0..223) and the SPGroup (0..15)<br><br><b>TODO</b> <br> <br> |
| <pre>PacketReadout([ChipIndex](#chipindex)) [Tpx4Packets](#tpx4packets)</pre> Reads out the TPX4 packets through the SlowControl interface.<br> Starting this call will enable a thread which continuously poll the PACKET_READOUT_BOTTOM and PACKET_READOUT_TOP registers and may impact performance of the control application and other SC commands. <br> <br> |
| <pre>PacketReadout2([Tpx4ReadoutOptions](#tpx4readoutoptions)) [Tpx4Packets](#tpx4packets)</pre> Packet readout with options. <br> <br> |
| <pre>PacketReadoutBurst([Tpx4BurstReadoutOptions](#tpx4burstreadoutoptions)) [Tpx4Packets](#tpx4packets)</pre> Read out a predefined number of packets.<br> Can not be used at the same time as PacketReadout2. <br> <br> |
| <pre>ShutterSetConfig([Tpx4ShutterConfig](#tpx4shutterconfig)) [Tpx4ShutterConfig](#tpx4shutterconfig)</pre> Configures the shutter.<br> Returned value is the actual values applied. As not all shutters are valid, the closest valid shutter duration will be chosen. <br> <br> |
| <pre>ShutterGetConfig([ChipIndex](#chipindex)) [Tpx4ShutterConfig](#tpx4shutterconfig)</pre> Returns the current shutter configuration. <br> <br> |
| <pre>ShutterOpen([ChipIndex](#chipindex)) [Empty](#empty)</pre> Opens the shutter (MATRIX_CTRL <= OPEN_SHUTTER). <br> <br> |
| <pre>ShutterClose([ChipIndex](#chipindex)) [Empty](#empty)</pre> Closes the shutter (MATRIX_CTRL <= CLOSE_SHUTTER). <br> <br> |
| <pre>ShutterStop([ChipIndex](#chipindex)) [Empty](#empty)</pre> Stops the shutter (MATRIX_CTRL <= STOP_SHUTTER). <br> <br> |
| <pre>T0Sync([ChipIndex](#chipindex)) [Empty](#empty)</pre> Issues a T0Sync command (MATRIX_CTRL <= T0_SYNC). <br> <br> |
| <pre>TestPulseSetConfig([Tpx4TestPulseConfig](#tpx4testpulseconfig)) [Tpx4TestPulseConfig](#tpx4testpulseconfig)</pre> Configures the test-pulse. <br> <br> |
| <pre>TestPulseGetConfig([ChipIndex](#chipindex)) [Tpx4TestPulseConfig](#tpx4testpulseconfig)</pre> Returns the current test-pulse configuration. <br> <br> |
| <pre>TestPulseEnable([ChipIndex](#chipindex)) [Empty](#empty)</pre> Enables test-pulse (register TP_CONF.tp_enable=1). <br> <br> |
| <pre>TestPulseDisable([ChipIndex](#chipindex)) [Empty](#empty)</pre> Disables test-pulses (register TP_CONF.tp_enable=0). <br> <br> |
| <pre>TestPulseIsEnabled([ChipIndex](#chipindex)) [ChipBoolValue](#chipboolvalue)</pre> Check if test-pulses are enabled (Returns TP_CONF.tp_enable=1). <br> <br> |
| <pre>TestPulseEnableColumns([Tpx4TestPulseColumnEnable](#tpx4testpulsecolumnenable)) [Empty](#empty)</pre> Update the enabled test-pulse double-columns. <br> <br> |
| <pre>TestPulseStart([ChipIndex](#chipindex)) [Empty](#empty)</pre> Start the test pulse (MTRIX_CTRL <= TP_EN). <br> <br> |
| <pre>TestPulseStop([ChipIndex](#chipindex)) [Empty](#empty)</pre> Stop a running test pulse (MTRIX_CTRL <= STOP_TP). <br> <br> |
| <pre>ReadoutSetConfig([Tpx4ReadoutConfig](#tpx4readoutconfig)) [Empty](#empty)</pre> Configure readout mode. <br> <br> |
| <pre>ReadoutGetConfig([ChipIndex](#chipindex)) [Tpx4ReadoutConfig](#tpx4readoutconfig)</pre> Return readout configuration. <br> <br> |
| <pre>StatusMonSetConfig([Tpx4StatusMonConfig](#tpx4statusmonconfig)) [Empty](#empty)</pre> Sets the status and monitoring configuration to both halfs of the chip. <br><br>If this is not what you want, use direct register access. <br> <br> |
| <pre>StatusMonGetConfig([ChipIndex](#chipindex)) [Tpx4StatusMonConfig](#tpx4statusmonconfig)</pre> Returns the status and monitoring configuration of the bottom half. <br> <br> |






### Messages



#### DacValue

A single DAC value.


| Field | Type | Description |
| ----- | ---- | ----------- |
| dac | [ Tpx4Dac](#tpx4dac) | DAC addressed |
| value | [ uint32](#uint32) | DAC value |






#### DacValueList

List of DAC values.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ uint32](#uint32) | Chip index |
| items | [repeated DacValue](#dacvalue) | List of DAC values |






#### ReadRegReply

Read register reply.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ uint32](#uint32) | Chip index |
| addr | [ int32](#int32) | Register address |
| count | [ int32](#int32) | number of registers from address |
| stride | [ int32](#int32) | Register stride |
| data | [ bytes](#bytes) | Register data |






#### ReadRegRequest

Read register request.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ uint32](#uint32) | Chip index |
| addr | [ int32](#int32) | Register address |
| count | [ int32](#int32) | No of registers to read from regAddr. |
| stride | [ int32](#int32) | Stride |
| length | [ int32](#int32) | Optional length, when not set uses full register. |






#### SimpleReadReply

Simple read reply for up to 32 bit values per register.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ uint32](#uint32) | none |
| addr | [ uint32](#uint32) | none |
| val | [ uint32](#uint32) | none |






#### SimpleReadRequest

Simple read request for up to 32 bit values per register.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ uint32](#uint32) | none |
| addr | [ uint32](#uint32) | none |






#### SimpleWriteRequest

Simple write request for up to 32 bit values per register.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ uint32](#uint32) | none |
| addr | [ uint32](#uint32) | none |
| val | [ uint32](#uint32) | none |
| mask | [ uint32](#uint32) | none |






#### Tpx4AdcConfig




| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ int32](#int32) | Chip index |
| nperiods | [ uint32](#uint32) | ADC cycles 1-65535. 8192 is a good value for this. |
| clock\_ref | [ uint32](#uint32) | Clock ref 306 Hz to 20 MHz, with 50 ns steps.<br> Clock will be rounded to closest possible speed. |






#### Tpx4AdcRequest

ADC conversion request.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ int32](#int32) | Chip index to sample |
| dac\_out | [ Tpx4DacOut](#tpx4dacout) | DAC out to sample |
| external | [ bool](#bool) | Use external ADC (if supported) |






#### Tpx4BroadcastPixelConfig

Pixel broadcast message.<br>
See Timepix4::ConfigPixelsBroadcast()


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ int32](#int32) | Chip index |
| columns | [repeated Tpx4ColumnAddress](#tpx4columnaddress) | Columns to use, or empty for all columns |
| config | [ bytes](#bytes) | 512 pixels (contains a double column of 256 pixels) |






#### Tpx4BroadcastSPGroupConfig

SPGroup broadcast message.<br>
See Timepix4::ConfigSPGroupsBroadcast()


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ int32](#int32) | Chip index |
| columns | [repeated Tpx4ColumnAddress](#tpx4columnaddress) | Columns to use, or keep empty for all columns |
| config | [repeated uint32](#uint32) | 16 SPGroup configurations, broadcast to all columns |






#### Tpx4BurstReadoutOptions




| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ int32](#int32) | Chip index |
| half | [ Tpx4Half](#tpx4half) | Which part to read |
| count | [ uint32](#uint32) | Number of packets to read. Must be a multiple of 4. |






#### Tpx4ColumnAddress

A *double* column address.


| Field | Type | Description |
| ----- | ---- | ----------- |
| half | [ Tpx4Half](#tpx4half) | Which chip half, either TPX4_BOTTOM or TPX4_TOP |
| column | [ int32](#int32) | Double column 0..223 |






#### Tpx4Packets

Streamed message containing TPX4 packets read out through the SlowControl interface.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ int32](#int32) | Chip index |
| packets | [repeated uint64](#uint64) | A sequence of packets |
| half | [ Tpx4Half](#tpx4half) | The half (top/bottom) the packets came from. 'both' if unknown. |






#### Tpx4PartialPixelConfig

Configures a part of the pixel matrix.<br>
This can be a combination of Columns pixels configuration (512 pixels)<br>
or SPGroup pixel configurations (32 pixels).

Column and SPGroup configurations may be intermixed.

See Timepix4::ConfigPixelsPartial()


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ int32](#int32) | Chip index |
| parts | [repeated Tpx4PartialPixelConfig.Tpx4PixelPart](#tpx4partialpixelconfigtpx4pixelpart) | One or more partial pixel configurations. |






#### Tpx4PartialPixelConfig\.Tpx4PixelPart

Partial pixel configuration element.<br>
This can either be a column (config = 512 bytes, sp_group is ignored),<br>
or a superpixel (config = 32 bytes, column and sp_group must be set).<br>
Any other combination will result in an error.


| Field | Type | Description |
| ----- | ---- | ----------- |
| half | [ Tpx4Half](#tpx4half) | none |
| column | [ int32](#int32) | none |
| sp\_group | [ int32](#int32) | none |
| config | [ bytes](#bytes) | none |






#### Tpx4PartialSPGroupConfig

Message to partially configure a SPGroup.<br>
See Timepix4::ConfigSPGroupsPartial()


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ int32](#int32) | Chip index |
| parts | [repeated Tpx4PartialSPGroupConfig.Tpx4SPGroupPart](#tpx4partialspgroupconfigtpx4spgrouppart) | none |






#### Tpx4PartialSPGroupConfig\.Tpx4SPGroupPart




| Field | Type | Description |
| ----- | ---- | ----------- |
| half | [ Tpx4Half](#tpx4half) | none |
| column | [ int32](#int32) | none |
| sp\_group | [ int32](#int32) | none |
| config | [ uint32](#uint32) | none |






#### Tpx4PixelConfig

Full PixelConfiguration object.<br>
See Timepix4::ConfigPixels.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ int32](#int32) | Chip index |
| config | [ bytes](#bytes) | Pixel configuration. Must consist of 229376 bytes (448x512 pixels, full matrix top and bottom) Order: <pre> For each Half(top, bottom) <br> For each colum (0..223) <br> For each SPGroup (0..15) <br> For each SuperPixel (0..3) <br> Write 8 x Pixel config (8 bits)<br> </pre> |
| setTpColumns | [ bool](#bool) | Enable automatically setting test-pulse columns |






#### Tpx4ReadoutConfig

Configure the readout mode.<br>
Note that gain and polarity are replaced by frontend mode, as
polarity and gain allow for invalid settings.<br>
(Partially) configures registers:
- MATRIX_CONF
- RO_CTRL_TOP/BOTTOM
- PC24B (if pc24b_thr >= 128)
- TOA_PRESET
- TOA_CONF


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ int32](#int32) | Index |
| mode | [ Tpx4ReadoutOp](#tpx4readoutop) | Mode to readout |
| pc24b\_thr | [ uint32](#uint32) | Threshold for photon counting mode (TPX4_READOUT_PC24), in hits. Note that this value is rounded to a multiple of 256. <br><br>Not setting this value will skip setting the threshold register. |
| gain | [ Tpx4Gain](#tpx4gain) | Gain mode<br> Deprecated: use analog_frontend_mode. |
| polarity | [ bool](#bool) | Set polarity (true - hole collection, false - electron collection)<br> Deprecated: use analog_frontend_mode. |
| toa\_enable | [ bool](#bool) | Enable Time-of-Arrival |
| toa\_config | [ Tpx4ToAConfig](#tpx4toaconfig) | Further ToA configuration (optional, otherwise doesn't modify registers) |
| analog\_frontend\_mode | [ Tpx4AnalogFrontEndMode](#tpx4analogfrontendmode) | Analog Front-end mode. Replaces polarity and gain. |






#### Tpx4ReadoutOptions

Packet read-out options (over SlowControl interface).


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ int32](#int32) | Chip index |
| half | [ Tpx4Half](#tpx4half) | Which part to stream |
| forward\_empty | [ bool](#bool) | Enable forwarding of empty packets (0xffffffff00000000).<br> Note: Empty packets are internally suppressed for optimization purposes. As such only a single empty packet frame will be included and only if reading all top or bottom registers are empty. |






#### Tpx4SPGroupConfig

Message for configuring ALL superpixel groups.<br>
See Timepix4::ConfigSPGroups()


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ int32](#int32) | none |
| config | [repeated uint32](#uint32) | none |






#### Tpx4ShutterConfig

Shutter configuration.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ int32](#int32) | Chip index |
| mode | [ Tpx4ShutterMode](#tpx4shuttermode) | Mode to chose |
| input | [ Tpx4ShutterInput](#tpx4shutterinput) | Select input to control the shutter subsystem. |
| prog\_open\_duration | [ uint64](#uint64) | Set shutter open duration in 25 ns ticks, only for TPX4_SHUTTER_MODE_*.<br> Note: The value is converted to a semi-floating point value but with positive exponent ranging from 0 to 31 and 11 bit fraction, no sign. The maximum value therefore is 0x7FF << 31, or 4395899027456 ticks, i.e. 30.5 hours. |
| prog\_close\_duration | [ uint64](#uint64) | Set shutter close duration in 25 ns ticks, only for TPX4_SHUTTER_MODE_* |
| prog\_open\_us | [ float](#float) | Set shutter open duration in us.<br> Due to the underlying coding the duration may be modified to match the closest possible duration. Review the returned Tpx4ShutterConfig object for the actual duration. |
| prog\_close\_us | [ float](#float) | Set shutter close duration in us.<br> Due to the underlying coding the duration may be modified to match the closest possible duration. Review the returned Tpx4ShutterConfig object for the actual duration. |






#### Tpx4StatusMonConfig

Status and monitoring configuration (register 0x4C02 and 0xCC02).


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ int32](#int32) | Chip index |
| enable | [ bool](#bool) | Enable status and monitoring packet generation |
| heartbeat | [ bool](#bool) | Enable the heartbeat |
| heartbeat\_shift | [ int32](#int32) | Heartbeat shift. A heartbeat is send every (1 << heatbeat_shift) * 25 ns. |
| global\_time\_reset | [ bool](#bool) | Resets the global time on T0-sync |
| global\_time | [ bool](#bool) | Enable the glboal time counter in status packets |
| ctrl\_data\_test | [ bool](#bool) | Generate ctrl data test packets |
| signal\_select | [ Tpx4SignalSelect](#tpx4signalselect) | Signal select. |






#### Tpx4TestPulseColumnEnable

Configure the enabled columns


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ int32](#int32) | Chip index |
| columns | [repeated Tpx4ColumnAddress](#tpx4columnaddress) | Double columns to enable test-pulse on.<br> Keep empty to enable ALL columns (top and bottom, not advised!) |






#### Tpx4TestPulseConfig

Test-pulse configuration.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ int32](#int32) | Chip index |
| count | [ uint32](#uint32) | Set TP on duration in 25 ns ticks.<br> Max value: 65535 |
| period\_on | [ uint32](#uint32) | Set TP on duration in 25 ns ticks.<br> Max value: 65535<br> Either specify period_on_s or period_on, but not both. |
| period\_off | [ uint32](#uint32) | Set TP off duration in 25 ns ticks.<br> Max value: 65535<br> Either specify period_off_s or period_off, but not both. |
| period\_on\_us | [ float](#float) | Set TP on duration in microseconds.<br> Max value: 1638.4 us<br> Either specify period_on_s or period_on, but not both. |
| period\_off\_us | [ float](#float) | Set TP off duration in microseconds.<br> Max value: 1638.4 us<br> Either specify period_off_us or period_off, but not both. |
| link\_shutter | [ bool](#bool) | When enabled, the shutter is opened if the test-pulse is enabled. |
| digital | [ bool](#bool) | Use digital test-pulse. |
| shutter2tp\_latency | [ uint32](#uint32) | Test pulse latency after shutter is opened, in 25 ns ticks.<br> Max value is 127. |
| phase | [ uint32](#uint32) | Clock phase, in units of 1.5625 ns.<br> Max value is 15. |
| columns | [repeated Tpx4ColumnAddress](#tpx4columnaddress) | double columns to enable test-pulse on.<br> Keep empty to enable ALL columns (top and bottom) |






#### Tpx4ToAConfig

Time-of-Arrival configuration (provided in TpxReadoutConfig message).


| Field | Type | Description |
| ----- | ---- | ----------- |
| preset | [ uint32](#uint32) | Time of arrival preset, loaded at T0 (0..65535) |
| maximum | [ uint32](#uint32) | Time of arrival maximum value (1..65535). 0 will not set the value. |
| falling\_edge | [ bool](#bool) | When set the ToA triggers on falling edge (otherwise rising) |
| stop\_on\_overflow | [ bool](#bool) | Set set, ToA stops on overflow |
| gray\_counter | [ bool](#bool) | When set use gray counter, otherwise binary |






#### WriteRegReply

Write register reply.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ uint32](#uint32) | Returned on success |






#### WriteRegRequest

Write register request.


| Field | Type | Description |
| ----- | ---- | ----------- |
| idx | [ uint32](#uint32) | Chip index |
| addr | [ int32](#int32) | Register address |
| count | [ int32](#int32) | number of registers from address |
| stride | [ int32](#int32) | Register stride |
| data | [ bytes](#bytes) | Register data |








### Enums


#### Tpx4AnalogFrontEndMode

Analog front-end mode.

Configures settings according to:
https://timepix4.web.cern.ch/timepix4/timepix4/ChipDescription/AnalogFrontEnd.html#id2

| Name | Number | Description |
| ---- | ------ | ----------- |
| TPX4_AFEM_USE_LEGACY | 0 | Use Tpx4ReadoutConfig polarity and gain properties. |
| TPX4_AFEM_HIGH_GAIN_ELECTRON_COLLECTION | 1 | High-Gain electron collection |
| TPX4_AFEM_LOW_GAIN_ELECTRON_COLLECTION | 2 | Low-Gain electron collection |
| TPX4_AFEM_HIGH_GAIN_HOLE_COLLECTION | 3 | High-Gain hole collection |
| TPX4_AFEM_LOW_GAIN_HOLE_COLLECTION | 4 | Low-Gain hole collection |
| TPX4_AFEM_LOG_GAIN_HOLE_COLLECTION | 5 | Logarithmic-Gain hole collection |




#### Tpx4Dac

Enumeration of DAC fields. This is a combination of the 'normal' DACs
and the GAIN dacs (VDAC)

| Name | Number | Description |
| ---- | ------ | ----------- |
| TPX4_DAC_UNKNOWN | 0 | none |
| TPX4_DAC_VBIASADC | 40960 | none |
| TPX4_DAC_VBIASDAC | 40961 | none |
| TPX4_DAC_VBIASDISCPMOS | 40962 | none |
| TPX4_DAC_VBIASDISCTRAFF | 40963 | none |
| TPX4_DAC_VBIASDISCTAILNMOS | 40964 | none |
| TPX4_DAC_VBIASIKRUM | 40965 | none |
| TPX4_DAC_VBIASLEVELSHIFT | 40966 | none |
| TPX4_DAC_VBIASPREAMP | 40967 | none |
| TPX4_DAC_VCASCDISC | 40968 | none |
| TPX4_DAC_VCASCPREAMP | 40969 | none |
| TPX4_DAC_VCONTROLVCO | 40970 | none |
| TPX4_DAC_VFBK | 40971 | none |
| TPX4_DAC_VTHRESHOLD | 40972 | none |
| TPX4_DAC_VTPULSECOARSE | 40973 | none |
| TPX4_DAC_VTPULSEFINE | 40974 | none |
| TPX4_VDAC_GAIN_VDAC_VCASCDISC | 40976 | none |
| TPX4_VDAC_GAIN_VDAC_VCASCPREAMP | 40977 | none |
| TPX4_VDAC_GAIN_VDAC_VCONTROLVCO | 40978 | none |
| TPX4_VDAC_GAIN_VDAC_VFBK | 40979 | none |
| TPX4_VDAC_GAIN_VDAC_VTHRESHOLD | 40980 | none |
| TPX4_VDAC_GAIN_VDAC_VTPULSECOARSE | 40981 | none |
| TPX4_VDAC_GAIN_VDAC_VTPULSEFINE | 40982 | none |




#### Tpx4DacOut

List of DAC-out choices.

| Name | Number | Description |
| ---- | ------ | ----------- |
| TPX4_OUT_HIZ | 0 | High impedance |
| TPX4_OUT_VBIASDISCTRAFF_TOP | 268435456 | AEOC_TOP VbiasDiscTRAFF |
| TPX4_OUT_VBIASDISCPMOS_TOP | 268437504 | AEOC_TOP VbiasDiscPMOS |
| TPX4_OUT_VBIASLEVELSHIFTPMOS_TOP | 268439552 | AEOC_TOP VbiasLevelShiftPMOS |
| TPX4_OUT_VBIASDAC_BIAS_TOP | 268441600 | AEOC_TOP VbiasDAC_bias |
| TPX4_OUT_VBIASDISCTAILNMOS_TOP | 268443648 | AEOC_TOP VbiasDiscTailNMOS |
| TPX4_OUT_VBIASIKRUM_TOP | 268445696 | AEOC_TOP VbiasIkrum |
| TPX4_OUT_VBIASPREAMP_TOP | 268447744 | AEOC_TOP VbiasPreamp |
| TPX4_OUT_VCO_VCONTROL_TOP | 268449792 | AEOC_TOP VCO_Vcontrol |
| TPX4_OUT_PS_MONITOR_ANALOG_AEOC_13_TOP | 268451840 | AEOC_TOP PS_monitor_analog_AEOC_13 |
| TPX4_OUT_PS_MONITOR_ANALOG_AEOC_32_TOP | 268453888 | AEOC_TOP PS_monitor_analog_AEOC_32 |
| TPX4_OUT_HIZ_CENTRE | 536870912 | @ Reset |
| TPX4_OUT_VBANDGAP_100MV_AT_RES | 541065216 | VBandGap 100mV at Res |
| TPX4_OUT_TEMP_SENSE | 545259520 | Temp Sensor |
| TPX4_OUT_VBIAS_BINDAC | 549453824 | DAC LSB VBias |
| TPX4_OUT_VCASC_BINDAC | 553648128 | DAC LSB Cascode |
| TPX4_OUT_VBANDGAP_100MV | 557842432 | VBandGap (~100mV) |
| TPX4_OUT_VBIASPREAMP | 562036736 | VBiasPreamp (I) |
| TPX4_OUT_VBIASDISCTAILNMOS | 566231040 | VBiasDiscTailNMOS (I) |
| TPX4_OUT_VBIASIKRUM | 570425344 | VBiasIkrum (I) |
| TPX4_OUT_VBIASDAC | 574619648 | VBiasDAC (I) |
| TPX4_OUT_VBIASLEVELSHIFT | 578813952 | VBiasLevelShift (I) |
| TPX4_OUT_VBIASDISCPMOS | 583008256 | VBiasDiscPMOS (I) |
| TPX4_OUT_VBIASDISCTRAFF | 587202560 | VBiasDiscTRAFF (I) |
| TPX4_OUT_VBIASADC | 591396864 | VbiasADC |
| TPX4_OUT_VCASCPREAMP_BOT | 595591168 | VCascPreamp (V) |
| TPX4_OUT_VBFK_BOT | 599785472 | VFBK (I) |
| TPX4_OUT_VTPULSECOARSE_BOT | 603979776 | VTpulseCoarse (V) |
| TPX4_OUT_VCASCDISC_BOT | 608174080 | VCascDisc (V) |
| TPX4_OUT_VCONTROLVCO_BOT | 612368384 | VcontrolVCO |
| TPX4_OUT_VTHRESHOLD_BOT | 616562688 | VThreshold (V) |
| TPX4_OUT_VTPULSEFINE_BOT | 620756992 | VTpulseFine (V) |
| TPX4_OUT_VCASCPREAMP_TOP | 624951296 | VCascPreamp (V) |
| TPX4_OUT_VBFK_TOP | 629145600 | VFBK (I) |
| TPX4_OUT_VTPULSECOARSE_TOP | 633339904 | VTpulseCoarse (V) |
| TPX4_OUT_VCASCDISC_TOP | 637534208 | VCascDisc (V) |
| TPX4_OUT_VCONTROLVCO_TOP | 641728512 | VcontrolVCO |
| TPX4_OUT_VTHRESHOLD_TOP | 645922816 | VThreshold (V) |
| TPX4_OUT_VTPULSEFINE_TOP | 650117120 | VTpulseFine (V) |
| TPX4_OUT_PS_MONTIOR_ANALOG_13_0 | 654311424 | PS_monitor placed at [270,15000] |
| TPX4_OUT_PS_MONTIOR_ANALOG_13_1 | 658505728 | PS_monitor placed at [8300,15000] |
| TPX4_OUT_PS_MONTIOR_ANALOG_13_2 | 662700032 | PS_monitor placed at [16330,15000] |
| TPX4_OUT_PS_MONTIOR_ANALOG_13_3 | 666894336 | PS_monitor placed at [24360,15000] |
| TPX4_OUT_PS_MONTIOR_ANALOG_23_0 | 671088640 | PS_monitor placed at [270,15000] |
| TPX4_OUT_PS_MONTIOR_ANALOG_23_1 | 675282944 | PS_monitor placed at [16330,15000] |
| TPX4_OUT_PS_MONTIOR_ANALOG_23_2 | 679477248 | PS_monitor placed at [16330,15000] |
| TPX4_OUT_PS_MONTIOR_ANALOG_23_3 | 683671552 | PS_monitor placed at [24360,15000] |
| TPX4_OUT_PS_MONTIOR_DIGITAL_13_0 | 687865856 | PS_monitor placed at [270,15000] |
| TPX4_OUT_PS_MONTIOR_DIGITAL_13_1 | 692060160 | PS_monitor placed at [16330,15000] |
| TPX4_OUT_PS_MONTIOR_DIGITAL_13_2 | 696254464 | PS_monitor placed at [16330,15000] |
| TPX4_OUT_PS_MONTIOR_DIGITAL_13_3 | 700448768 | PS_monitor placed at [24360,15000] |
| TPX4_OUT_PS_MONTIOR_DIGITAL_23_0 | 704643072 | PS_monitor placed at [270,15000] |
| TPX4_OUT_PS_MONTIOR_DIGITAL_23_1 | 708837376 | PS_monitor placed at [16330,15000] |
| TPX4_OUT_PS_MONTIOR_DIGITAL_23_2 | 713031680 | PS_monitor placed at [16330,15000] |
| TPX4_OUT_PS_MONTIOR_DIGITAL_23_3 | 717225984 | PS_monitor placed at [24360,15000] |
| TPX4_OUT_VBIASDISCTRAFF_BOT | 805306368 | AEOC_BOT VbiasDiscTRAFF |
| TPX4_OUT_VBIASDISCPMOS_BOT | 805306369 | AEOC_BOT VbiasDiscPMOS |
| TPX4_OUT_VBIASLEVELSHIFTPMOS_BOT | 805306370 | AEOC_BOT VbiasLevelShiftPMOS |
| TPX4_OUT_VBIASDAC_BIAS_BOT | 805306371 | AEOC_BOT VbiasDAC_bias |
| TPX4_OUT_VBIASDISCTAILNMOS_BOT | 805306372 | AEOC_BOT VbiasDiscTailNMOS |
| TPX4_OUT_VBIASIKRUM_BOT | 805306373 | AEOC_BOT VbiasIkrum |
| TPX4_OUT_VBIASPREAMP_BOT | 805306374 | AEOC_BOT VbiasPreamp |
| TPX4_OUT_VCO_VCONTROL_BOT | 805306375 | AEOC_BOT VCO_Vcontrol |
| TPX4_OUT_PS_MONITOR_ANALOG_AEOC_13_BOT | 805306376 | AEOC_BOT PS_monitor_analog_AEOC_13 |
| TPX4_OUT_PS_MONITOR_ANALOG_AEOC_32_BOT | 805306377 | AEOC_BOT PS_monitor_analog_AEOC_32 |
| TPX4_OUT_TOP_ANALOG_IN | 1073741824 | External analog input from top edge periphery |
| TPX4_OUT_CENTRE_ANALOG_IN | 1342177280 | External analog input from center edge periphery |
| TPX4_OUT_BOT_ANALOG_IN | 1610612736 | External analog input from bottom edge periphery |




#### Tpx4Gain

Gain mode.

deprecated: use analog_frontend_mode.

| Name | Number | Description |
| ---- | ------ | ----------- |
| TPX4_NO_GAIN | 0 | No gain applied |
| TPX4_LOW_GAIN | 1 | Low gain |
| TPX4_LOG_GAIN | 2 | Log gain (use only with polarity=true) |
| TPX4_LOW_LOG_GAIN | 3 | Low log gain (don't use this! Present for legacy reasons) |




#### Tpx4Half

TPX4 top or bottom.

| Name | Number | Description |
| ---- | ------ | ----------- |
| TPX4_BOTH | 0 | none |
| TPX4_BOTTOM | 1 | none |
| TPX4_TOP | 2 | none |
| TPX4_UNKNOWN | 3 | none |




#### Tpx4ReadoutOp

Read-out mode for data acquisition.

| Name | Number | Description |
| ---- | ------ | ----------- |
| TPX4_READOUT_TOA_TOT | 0 | Time over threshold mode |
| TPX4_READOUT_PC24 | 1 | 24 bit photon counting mdoe |
| TPX4_READOUT_FRAME8 | 2 | 8 bit framebased readout |
| TPX4_READOUT_FRAME16 | 3 | 16 bit framebase readout |




#### Tpx4ShutterInput

Shutter input source.

| Name | Number | Description |
| ---- | ------ | ----------- |
| TPX4_SHUTTER_INPUT_PAD | 0 | Single shutter on trigger (shutter_select=0) |
| TPX4_SHUTTER_INPUT_SLOW_CONTROL | 1 | Shutter repeated after start (shutter_select=1) |




#### Tpx4ShutterMode

The shutter modes.

| Name | Number | Description |
| ---- | ------ | ----------- |
| TPX4_SHUTTER_MODE_PROG_SINGLE | 0 | Single shutter on trigger (periodic_shutter=0, shutter_mode=1) |
| TPX4_SHUTTER_MODE_PROG_REPEAT | 1 | Shutter repeated after start (periodic_shutter=1, shutter_mode=1) |
| TPX4_SHUTTER_MODE_MANUAL | 2 | Shutter controlled by selected input (shutter_mode=0) |




#### Tpx4SignalSelect

Status and monitoring signal select.

| Name | Number | Description |
| ---- | ------ | ----------- |
| TPX4_SIGNAL_SELECT_NONE | 0 | none |
| TPX4_SIGNAL_SELECT_CRW_NEXT_FRAME | 1 | none |
| TPX4_SIGNAL_SELECT_INVALID | 15 | none |








---

## peripheral.proto



### Services

#### Peripheral

Peripheral service exposes devices on the board,
 not directly related to the pixelchips.

All devices have three distinct types of values:<br>
  Configuration, Sensor and Actuator.

Depending on the type you may be able to Set, or Get them.

In the back-end these peripheral values are provided by Devices, which
execute the actual operations on the data. It is possible to request the status
of these specific devices and to enable and disable then.

| Methods|
| ------ |
| <pre>GetSenseData([Empty](#empty)) [DataPointList](#datapointlist)</pre> Request all sensor data. <br> <br> |
| <pre>SenseNow([StringList](#stringlist)) [DataPointList](#datapointlist)</pre> Update specific sensor values now.<br> StringList contains variable IDs to update.<br> All data-points updated.<br> This call is blocking and may require time depending on the number of variables requested. <br> <br> |
| <pre>GetMetaData([StringList](#stringlist)) [MetaDataList](#metadatalist)</pre> Returns MetaData for DataPoints.<br> StringList contains the IDs of which you want know the MetaData.<br> IDs can be of any specific variable (e.g. config, sense or actuate). <br> <br> |
| <pre>GetConfigData([Empty](#empty)) [DataPointList](#datapointlist)</pre> Returns the configuration data. <br> <br> |
| <pre>GetActuateData([Empty](#empty)) [DataPointList](#datapointlist)</pre> Returns all actuator data. <br> <br> |
| <pre>ActuateNow([DataPointList](#datapointlist)) [Empty](#empty)</pre> Sets actuator values and applies them.<br> This call is blocking until actuation has been applied. <br> <br> |
| <pre>GetDeviceStatus([Empty](#empty)) [DeviceStatusList](#devicestatuslist)</pre> Returns all devices configured and their status. <br> <br> |
| <pre>EnableDevice([StringValue](#stringvalue)) [DeviceStatus](#devicestatus)</pre> Enable a device, will configure it if possible.<br> This call is blocking until the Device has been successfully enabled.<br> StringValue contains the name of the Device.<br> Returns the DeviceStatus of the specified Device. <br> <br> |
| <pre>DisableDevice([StringValue](#stringvalue)) [DeviceStatus](#devicestatus)</pre> Disable a device with that name.<br> StringValue contains the name of the Device. <br> <br> |






### Messages



#### DataPoint

Datapoint abstraction, representing a single process variable.


| Field | Type | Description |
| ----- | ---- | ----------- |
| id | [ string](#string) | Qualified ID |
| value | [ Value](#value) | Value |
| valid | [ bool](#bool) | Validity of value |






#### DataPointList

List of data-points.


| Field | Type | Description |
| ----- | ---- | ----------- |
| items | [repeated DataPoint](#datapoint) | List of datapoints |






#### DeviceStatus

Status of a device.


| Field | Type | Description |
| ----- | ---- | ----------- |
| name | [ string](#string) | Device name |
| part | [ string](#string) | Part name (= driver) |
| valid | [ bool](#bool) | Whether or not the device is valid |
| disabled | [ bool](#bool) | Whether or not the device is disabled |
| busname | [ string](#string) | Bus name (if any) |
| address | [ int32](#int32) | Address on bus |
| busname\_mux | [ string](#string) | Bus name of I2C bus switch (if any) |
| address\_mux | [ int32](#int32) | Address of the switch |
| mux\_channel | [ int32](#int32) | Switch channel this device is on |






#### DeviceStatusList

List of board devices.


| Field | Type | Description |
| ----- | ---- | ----------- |
| items | [repeated DeviceStatus](#devicestatus) | List of DeviceStatus |






#### MetaData

Meta-data of a datapoint.


| Field | Type | Description |
| ----- | ---- | ----------- |
| id | [ string](#string) | Qualified ID |
| unit | [ string](#string) | Unit |
| desc | [ string](#string) | Description |
| role | [ DataRole](#datarole) | Data role |






#### MetaDataList




| Field | Type | Description |
| ----- | ---- | ----------- |
| items | [repeated MetaData](#metadata) | none |






#### Value




| Field | Type | Description |
| ----- | ---- | ----------- |
| type | [ ValueType](#valuetype) | Type of the value |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) value.int\_value | [ int32](#int32) | Value, if type is INT |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) value.float\_value | [ float](#float) | Value, if type is FLOAT |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) value.bool\_value | [ bool](#bool) | Value, if type is BOOLEAN |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) value.string\_value | [ string](#string) | Value, if type is STRING |








### Enums


#### DataRole

Data role of the datapoint.

| Name | Number | Description |
| ---- | ------ | ----------- |
| SENSOR | 0 | Data is a sensor value (read only) |
| ACTUATOR | 1 | Data is an actuator value |
| CONFIG | 2 | Data is a configuration value |




#### ValueType

Type of value.

| Name | Number | Description |
| ---- | ------ | ----------- |
| INVALID | 0 | Invalid type (not a type) |
| INT | 1 | Integer type (32-bits signed) |
| FLOAT | 2 | Floating point type |
| BOOLEAN | 3 | Boolean type. |
| STRING | 4 | String type.... |








---

## daq.proto



### Services

#### Daq

SPIDR4 DAQ service.

| Methods|
| ------ |
| <pre>GetVersion([Empty](#empty)) [Version](#version)</pre> Returns the build version of the DAQ server. <br> <br> |
| <pre>GetLogging([Empty](#empty)) [LogLine](#logline)</pre> Returns console logging as a stream. <br> <br> |
| <pre>ConfigPipeline([PipelineConfig](#pipelineconfig)) [Empty](#empty)</pre> Configures the pipeline, a source to target mapping. <br> <br> |
| <pre>ConfigDaq([DaqConfig](#daqconfig)) [DaqConfig](#daqconfig)</pre> Configure the DAQ settings. <br> <br> |
| <pre>Start([RunProperties](#runproperties)) [RunProperties](#runproperties)</pre> Start the data-acquisition.<br> Returns the run-properties as applied. <br> <br> |
| <pre>Stop([Empty](#empty)) [DaqStatus](#daqstatus)</pre> Stop the data-acquisition and returns the last DaqStatus object.<br> Contrary to GetStatus, this will return ALL files written during the run, not only those which are new. <br> <br> |
| <pre>IsRunning([Empty](#empty)) [BoolValue](#boolvalue)</pre> Check if the DAQ is running. <br> <br> |
| <pre>GetStatus([Empty](#empty)) [DaqStatus](#daqstatus)</pre> Get a stream of DAQ status object, sent roughly every half a second.<br> Note that if the DAQ is not running, no DaqStatus objects will be generated. Check function IsRunning() whether or not the DAQ is running. <br> <br> |
| <pre>InsertUserData([UserDataFrame](#userdataframe)) [BoolValue](#boolvalue)</pre> Insert a custom user-data packet into a stream.<br> If the acquisition is not yet running, packets will be inserted at the beginning of the stream, otherwise they end up embedded in the data stream.<br> Returns a boolean indicating whether there are user packets still in the queue to be inserted in the data stream (always true when a packet is inserted, but calling this method without an actual packet to insert can be used to poll the status of this queue). <br> <br> |
| <pre>EnablePixelInspection([EnableMessage](#enablemessage)) [Empty](#empty)</pre> Enable or disable 'pixel inspection' in a stream, i.e. counting pixels and EoC occurrences. <br> <br> |
| <pre>GetPixelPacketCount([UInt32Value](#uint32value)) [UInt64Value](#uint64value)</pre> Request the number of 64-bit pixel packets processed (requires active 'pixel inspection'). <br> <br> |
| <pre>GetShutterRiseCount([UInt32Value](#uint32value)) [UInt64Value](#uint64value)</pre> Request the number of ShutterRise occurrences (requires active 'pixel inspection'). <br> <br> |
| <pre>GetShutterFallCount([UInt32Value](#uint32value)) [UInt64Value](#uint64value)</pre> Request the number of ShutterFall occurrences (requires active 'pixel inspection'). <br> <br> |
| <pre>GetHeartbeatCount([UInt32Value](#uint32value)) [UInt64Value](#uint64value)</pre> Request the number of Heartbeat occurrences (requires active 'pixel inspection'). <br> <br> |






### Messages



#### Consumer

A DAQ consumer.


| Field | Type | Description |
| ----- | ---- | ----------- |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) target.file\_destination | [ FileDestination](#filedestination) | none |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) target.udp\_address | [ InetAddress](#inetaddress) | none |






#### ConsumerStats




| Field | Type | Description |
| ----- | ---- | ----------- |
| consumed | [ uint64](#uint64) | Bytes consumed |
| userdataqueue\_count | [ uint32](#uint32) | Number of items (still) in the user data output queue |
| artifacts | [repeated string](#string) | String list of artifacts generated.<br> When using the file-type consumer the artifacts are file names. |






#### DaqConfig

Message to configure the DAQ process. 
Currently there is nothing to configure, but we're sure
there will be something to configure in the future!





#### DaqStatus

Status of the DAQ process.


| Field | Type | Description |
| ----- | ---- | ----------- |
| stopping | [ bool](#bool) | Whether or not the DAQ is stopping |
| ts | [ double](#double) | Time at which the message was generated. Fractional Unix time. |
| runtime | [ double](#double) | Time the DAQ process is running, in seconds |
| stream\_stats | [repeated StreamStats](#streamstats) | For each stream in the pipeline, run-time information |






#### EnableMessage

Enable or disable a feature of a selected stream.


| Field | Type | Description |
| ----- | ---- | ----------- |
| stream\_idx | [ uint32](#uint32) | Stream index, 0 for first, 1 for second, etc. |
| enable | [ bool](#bool) | Enable or disable. |






#### FileDestination

Data file destination parameters.


| Field | Type | Description |
| ----- | ---- | ----------- |
| basename | [ string](#string) | none |
| no\_date | [ bool](#bool) | none |
| max\_chunk\_size | [ uint32](#uint32) | Maximum chunk size in a file, in MB, leave 0 for default (=16 MB). A chunk is a fundamental unit of the SPIDR4 data format. Larger chunks offer better efficiency, but can be more difficult to handle. |
| max\_file\_size | [ uint32](#uint32) | Maximum file-size in MB, before creating a new one, leave 0 for default (=4096 MB). |






#### PipelineConfig

A pipeline config.


| Field | Type | Description |
| ----- | ---- | ----------- |
| streams | [repeated Stream](#stream) | Configure a number of streams Note: The first stream gets index 0, second index 1, and so on. |






#### Receiver

A DAQ Receiver.


| Field | Type | Description |
| ----- | ---- | ----------- |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) source.xgbe\_address | [ InetAddress](#inetaddress) | none |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) source.pci\_channel | [ uint32](#uint32) | none |
| buffer\_size | [ uint32](#uint32) | Receive buffer size, per pipeline, in MB, leave 0 for default (=1024 MB). The amount of memory allocated for this receiver. The combined amount of allocated memory for all receivers must not exceed the amount of available memory allocated by the cmem driver (at host bootup time), or, if the cmem driver is not used (cmem is mandatory for PCIe read-out only), must not exceed available host user memory. |






#### RunProperties

Properties specific to a DAQ run.


| Field | Type | Description |
| ----- | ---- | ----------- |
| run\_no | [ uint32](#uint32) | The run number to advertise |
| daq\_secs | [ uint32](#uint32) | Number of seconds to run te data acquisition, 0 for infinite |






#### Stream

A part of a pipeline.


| Field | Type | Description |
| ----- | ---- | ----------- |
| receiver | [ Receiver](#receiver) | The receiver |
| consumers | [repeated Consumer](#consumer) | Consumers, currently limited to a single target |
| controller\_address | [ string](#string) | The address of the SPIDR4 controller associated with this stream |
| chip\_index | [ int32](#int32) | The index of the Timepix4 chip associated with this stream |
| custom\_header | [ uint64](#uint64) | Custom frame header for data chunks, used if unequal to zero |
| include\_chip\_config | [ bool](#bool) | Whether to include the Timepix4 configuration data (register contents) in the stream |






#### StreamStats

Stream statistics


| Field | Type | Description |
| ----- | ---- | ----------- |
| received | [ uint64](#uint64) | Bytes received |
| consumer\_stats | [repeated ConsumerStats](#consumerstats) | Per consumer information |






#### UserDataFrame

Insert user-data frame into a stream during or before DAQ.<br>
Please see the SPIDR4 data file format.<br>
For the frame header:
- group ID always set to 7
- content-encoding depends on whether binary (0) or json (1)is provided
- content ID is the lower 10 bits from the content_id field (>10 bits will be ignored)


| Field | Type | Description |
| ----- | ---- | ----------- |
| stream\_idx | [ uint32](#uint32) | Stream index, 0 for first, 1 for second, etc. |
| content\_id | [ uint32](#uint32) | User-data content type identifier.<br> Defined by the user to identify the content of the frame. Range: 0..1023 |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) data.binary | [ bytes](#bytes) | Binary data to insert |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) data.json | [ string](#string) | JSON data to insert |
| [**oneof**](https://developers.google.com/protocol-buffers/docs/proto3#oneof) data.status | [ uint32](#uint32) | Status request (no data frame inserted) |










## Scalar Value Types

| .proto Type | Notes | C++ Type | Java Type | Python Type |
| ----------- | ----- | -------- | --------- | ----------- |
| <a name="double" /> double |  | double | double | float |
| <a name="float" /> float |  | float | float | float |
| <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int |
| <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long |
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long |
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long |
| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int |
| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long |
| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int |
| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long |
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int |
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long |
| <a name="bool" /> bool |  | bool | boolean | boolean |
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |