Protocol Documentation

Table of Contents

• cwspb/air.proto

  • Id
  • Plain

• cwspb/common.proto

  • Coordinates
  • Dimension
  • Illumination
  • Obstruction
  • Temperature

• cwspb/layer.proto

  • Air
  • Illumination
  • Obstruction
  • Subject
  • WirelessNetwork

• cwspb/map.proto

  • Cell
  • Map

• cwspb/network.proto

  • Packet
  • WirelessContainer

• cwspb/physical.proto

  • Physical

• cwspb/service/common.proto

  • AirId
  • SubjectId

• cwspb/service/general.proto

  • Request

  • Response

  • Status

  • ErrorType

• cwspb/service/sv_device.proto

  • RequestDevice

  • RequestTransmitPackets

  • RequestTurnDevice

  • ResponseCameraInfo

  • ResponseReceivedPackets

  • ResponseSensorAirTemperature

  • ResponseSensorIllumination

  • DeviceService

• cwspb/service/sv_map.proto

  • RequestCell

  • RequestDimension

  • RequestInsertAir

  • RequestModifySubject

  • RequestSelectAir

  • RequestSelectSubject

  • ResponseCell

  • ResponseDimension

  • ResponseMap

  • ResponseSelectAir

  • ResponseSelectSubject

  • SubjectModifyType

  • MapService

• cwspb/service/sv_simulation.proto

  • RequestSimulationState

  • ResponseSimulationState

  • SimulationState

  • SimulationService

• cwspb/subject.proto

  • Any
  • BaseCamera
  • Id
  • InfraredCamera
  • LightCamera
  • LightEmitter
  • LightSourceParams
  • Plain
  • SensorAirTemperature
  • SensorIllumination
  • TempEmitter
  • TempSourceParams
  • Turnable
  • TurnableLightEmitter
  • TurnableTempEmitter
  • WirelessNetworkDevice

• Scalar Value Types

Top

cwspb/air.proto

Id

Field	Type	Label	Description
type	int32
idx	int32

Plain

Field	Type	Label	Description
base	cwspb.Physical
id	Id
heat_transfer_coef	double

Top

cwspb/common.proto

Coordinates

Field	Type	Label	Description
x	int32
y	int32

Dimension

Field	Type	Label	Description
width	int32
height	int32

Illumination

Field	Type	Label	Description
value	double

Obstruction

Field	Type	Label	Description
value	double

Temperature

Field	Type	Label	Description
value	double

Top

cwspb/layer.proto

Air

Field	Type	Label	Description
airs	cwspb.air.Plain	repeated

Illumination

Field	Type	Label	Description
illumination	cwspb.Illumination

Obstruction

Field	Type	Label	Description
light_obstruction	cwspb.Obstruction
air_obstruction	cwspb.Obstruction
wireless_obstruction	cwspb.Obstruction

Subject

Field	Type	Label	Description
subjects	cwspb.subject.Any	repeated

WirelessNetwork

Field	Type	Label	Description
transmitables	cwspb.network.WirelessContainer	repeated
receivables	cwspb.network.WirelessContainer	repeated

Top

cwspb/map.proto

Cell

Field	Type	Label	Description
coordinates	Coordinates
air	layer.Air
illumination	layer.Illumination
wireless_network	layer.WirelessNetwork
obstruction	layer.Obstruction
subject	layer.Subject

Map

Field	Type	Label	Description
dimension	Dimension
cells	Cell	repeated

Top

cwspb/network.proto

Packet

Field	Type	Label	Description
content	bytes

WirelessContainer

Field	Type	Label	Description
packet	Packet
signal_power	double

Top

cwspb/physical.proto

Physical

Field	Type	Label	Description
weight	double
heat_capacity	double
temperature	Temperature
light_obstruction	Obstruction
wireless_obstruction	Obstruction

Top

cwspb/service/common.proto

AirId

Field	Type	Label	Description
coordinates	Coordinates
id	air.Id

SubjectId

Field	Type	Label	Description
coordinates	Coordinates
id	subject.Id

Top

cwspb/service/general.proto

Request

Response

Field	Type	Label	Description
status	Status

Status

Field	Type	Label	Description
text	string	optional
type	ErrorType	optional

ErrorType

Name	Number	Description
ERROR_TYPE_UNSPECIFIED	0
ERROR_TYPE_BAD_REQUEST	1

Top

cwspb/service/sv_device.proto

RequestDevice

Field	Type	Label	Description
base	Request
id	SubjectId

RequestTransmitPackets

Field	Type	Label	Description
base	RequestDevice
id	SubjectId
packets	network.Packet	repeated

RequestTurnDevice

Field	Type	Label	Description
base	Request
id	SubjectId
turnable_status	int32

ResponseCameraInfo

Field	Type	Label	Description
base	Response
visible_subjects	SubjectId	repeated

ResponseReceivedPackets

Field	Type	Label	Description
base	Response
packets	network.Packet	repeated

ResponseSensorAirTemperature

Field	Type	Label	Description
base	Response
temp	Temperature

ResponseSensorIllumination

Field	Type	Label	Description
base	Response
illumination	Illumination

DeviceService

Method Name	Request Type	Response Type	Description
GetAirTemperature	RequestDevice	ResponseSensorAirTemperature
GetIllumination	RequestDevice	ResponseSensorIllumination
GetCameraInfo	RequestDevice	ResponseCameraInfo
TransmitPacket	RequestTransmitPackets	Response
ReceivePackets	RequestDevice	ResponseReceivedPackets
TurnDevice	RequestTurnDevice	Response

Top

cwspb/service/sv_map.proto

RequestCell

Field	Type	Label	Description
base	Request
coordinates	Coordinates

RequestDimension

Field	Type	Label	Description
base	Request
dimension	Dimension

RequestInsertAir

Field	Type	Label	Description
base	Request
coordinates	Coordinates
air	air.Plain

RequestModifySubject

Field	Type	Label	Description
base	Request
modify_type	SubjectModifyType
id	SubjectId		before
subject	subject.Any		after

RequestSelectAir

Field	Type	Label	Description
base	Request
id	AirId

RequestSelectSubject

Field	Type	Label	Description
base	Request
id	SubjectId

ResponseCell

Field	Type	Label	Description
base	Response
cell	Cell

ResponseDimension

Field	Type	Label	Description
base	Response
dimension	Dimension

ResponseMap

Field	Type	Label	Description
base	Response
map	Map

ResponseSelectAir

Field	Type	Label	Description
base	Response
air	air.Plain

ResponseSelectSubject

Field	Type	Label	Description
base	Response
subject	subject.Any

SubjectModifyType

Name	Number	Description
SUBJECT_MODIFY_TYPE_UNSPECIFIED	0
SUBJECT_MODIFY_TYPE_INSERT	1
SUBJECT_MODIFY_TYPE_UPDATE	2
SUBJECT_MODIFY_TYPE_DELETE	3

MapService

Method Name	Request Type	Response Type	Description
GetMapDimension	Request	ResponseDimension
CreateMap	RequestDimension	Response	aka SetMapDimension
GetCell	RequestCell	ResponseCell
GetMap	Request	ResponseMap
GetMapCells	Request	ResponseCell stream
GetSubject	RequestSelectSubject	ResponseSelectSubject
SetSubject	RequestModifySubject	Response
GetAir	RequestSelectAir	ResponseSelectAir
InsertAir	RequestInsertAir	Response

Top

cwspb/service/sv_simulation.proto

RequestSimulationState

Field	Type	Label	Description
state	SimulationState

ResponseSimulationState

Field	Type	Label	Description
base	Response
state	SimulationState

SimulationState

Field	Type	Label	Description
status	int32	optional
type	int32	optional
task_frequency	double	optional
current_tick	int32	optional
last_tick	int32	optional

SimulationService

Method Name	Request Type	Response Type	Description
GetSimulationState	Request	ResponseSimulationState
SetSimulationState	RequestSimulationState	Response

Top

cwspb/subject.proto

Any

Field	Type	Label	Description
plain	Plain
temp_emitter	TempEmitter
turnable_temp_emitter	TurnableTempEmitter
light_emitter	LightEmitter
turnable_light_emitter	TurnableLightEmitter
wireless_network_device	WirelessNetworkDevice
infrared_camera	InfraredCamera
light_camera	LightCamera
turnable	Turnable
sensor_air_temperature	SensorAirTemperature
sensor_illumination	SensorIllumination

BaseCamera

Field	Type	Label	Description
base	Plain
power	double
power_threshold	double

Id

Field	Type	Label	Description
type	int32
idx	int32

InfraredCamera

Field	Type	Label	Description
base	BaseCamera

LightCamera

Field	Type	Label	Description
base	BaseCamera
light_threshold	double

LightEmitter

Field	Type	Label	Description
base	Plain
temp_params	TempSourceParams
light_params	LightSourceParams

LightSourceParams

Field	Type	Label	Description
raw_illumination	cwspb.Illumination

Plain

Field	Type	Label	Description
base	cwspb.Physical
id	Id
surface_area	double
air_obstruction	cwspb.Obstruction

SensorAirTemperature

Field	Type	Label	Description
base	Plain
air_temperature	cwspb.Temperature

SensorIllumination

Field	Type	Label	Description
base	Plain
cell_illumination	cwspb.Illumination

TempEmitter

Field	Type	Label	Description
base	Plain
temp_params	TempSourceParams

TempSourceParams

Field	Type	Label	Description
heat_production	double

Turnable

Field	Type	Label	Description
base	Plain
turnable_status	int32
off_light_obs	cwspb.Obstruction
off_wireless_obs	cwspb.Obstruction
off_air_obs	cwspb.Obstruction

TurnableLightEmitter

Field	Type	Label	Description
base	LightEmitter
turnable_status	int32
off_light_params	LightSourceParams
off_temp_params	TempSourceParams

TurnableTempEmitter

Field	Type	Label	Description
base	TempEmitter
turnable_status	int32
off_temp_params	TempSourceParams

WirelessNetworkDevice

Field	Type	Label	Description
base	Plain
transmit_packets	cwspb.network.Packet	repeated
received_packets	cwspb.network.Packet	repeated
transmit_power	double
receive_threshold	double

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
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	int32	int	integer	Bignum or Fixnum (as required)
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	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)