package goosci

Mouse Melon logoGet desktop application:
View/edit binary Protocol Buffers messages

message AnalogPin

sensor.proto:46

Analog pin number refers to the numeric value in A0, A1, A2... use this to request values from an analog pin on the Device.

Used in: Pin

message AnalogValue

sensor.proto:105

AnalogValue contains a stream of single-dimensional integer values collected from an analog pin on the Device.

Used in: Data

message BasicSensorAppearance

basic_sensor_appearance.proto:28

Used in: SensorSpec, Trial.AppearanceEntry

message BleSensorConfig

sensor_config.proto:26

message BleSensorConfig.ScaleTransform

sensor_config.proto:43

Defines a linear transform that maps the range [sourceBottom, sourceTop] in the incoming data to [destBottom, destTop] in the outgoing, filtered data.

Used in: BleSensorConfig

message Caption

caption.proto:27

A user-added caption. This can be applied to trials and labels.

Used in: Label, Trial

message Change

experiment.proto:130

A single change to the experiment. Adding, editing, or deleting labels, titles, or trials will all result in a new change being added here. Used for resoving conflicts between client and server.

Used in: Experiment

enum Change.ChangeType

experiment.proto:131

Used in: Change

message ChangedElement

experiment.proto:165

An indication of what element was changed by this change.

Used in: Change

enum ChangedElement.ElementType

experiment.proto:166

Used in: ChangedElement

message Data

sensor.proto:131

Used in: SensorData

enum DataType

sensor.proto:57

Data type of a scalar

message DeviceSpec

device_spec.proto:40

Proto containing information about a device that hosts sensors. This may be (a) the host device itself (phone or tablet) with internal sensors (b) an Arduino running the Science Journal firmware (c) an external piece of hardware (like Vernier sensor) discovered by a third-party app implementing the scalar API. Devices that host sensors that have been connected to are remembered as "My Devices", which puts them in a special section of the Manage Sensors page to be easily found again later. Added in V2.

Used in: UserMetadata

message DigitalPin

sensor.proto:52

Digital pin number refers to the numeric value in D2, D3... use this to request values from a digital pin on the Device.

Used in: Pin

message DigitalValue

sensor.proto:112

DigitalValue contains a stream of single-dimensional boolean values collected from an digital pin on the Device. We use bool to represent DigitalValues, although packed bytes would be a more efficient encoding.

Used in: Data

message Empty

sensor.proto:28

(message has no fields)

message Error

sensor.proto:147

Used in: SensorData

message Experiment

experiment.proto:39

Experiment protobuf definition. Added in V2.

message Experiment.SensorEntry

experiment.proto:75

Version 1.1: Added

Used in: Experiment

message ExperimentLibrary

experiment_library.proto:29

The overall collection of Experiments known to the user. Next Tag: 3 LINT: LEGACY_NAMES

message ExperimentOverview

user_metadata.proto:60

Data about an experiment that is specific to a device. Some data, like title and imagePath, is duplicated here in order to make the Experiment List load faster: this way we don't need to parse every available experiment.

Used in: UserMetadata

message ExperimentSensor

experiment.proto:117

Sensors included or excluded in an experiment. TODO: Work with saff to figure out if other information needs to be included, such as a name the user gives their device that represents the type of sensors.

Used in: Experiment

message ExperimentStatus

local_sync_status.proto:35

The sync status of a single experiment.

Used in: LocalSyncStatus

message FileVersion

version.proto:34

Represents the version of a file that is written and may someday be shared with another version of the app. Added in V2.

Used in: Experiment, UserMetadata

message FloatValue

sensor.proto:117

FloatValue contains a stream of single-dimensional floating point values synthesized by the Firmware from data collected on the Device.

Used in: Data

message GadgetInfo

gadget_info.proto:29

Information about a device (which contains sensors) or sensor (which can give a data stream) that has been seen on this platform. Please see usage in context in sensor_spec.proto and device_spec.proto Added in V2

Used in: DeviceSpec, SensorSpec

enum GadgetInfo.Platform

gadget_info.proto:30

Used in: FileVersion, GadgetInfo

message IconPath

icon_path.proto:28

the path to an image that is used to represent a sensor

Used in: BasicSensorAppearance

enum IconPath.PathType

icon_path.proto:29

Used in: IconPath

message InputDeviceConfig

input_device.proto:26

message IntValue

sensor.proto:122

IntValue contains a stream of single-dimensional integer values synthesized by the Firmware from data collected on the Device.

Used in: Data

message Interval

sensor.proto:86

How many times, and how frequently the Device should return values for this request. If count is greater than 1, then the Device should return values every frequency milliseconds until the count is exceeded.

Used in: SensorDataRequest

message Label

label.proto:32

Label protobuf definition Added in V2.

Used in: Experiment, Trial

enum Label.ValueType

label.proto:51

Used in: Label

message LabelValue

label_value.proto:30

The contents of a label, able to represent many different types of data. This is deprecated in V2.

enum LabelValue.ValueType

label_value.proto:44

TODO: document how data and proto_data are written and read for each type

Used in: LabelValue

message LocalSyncStatus

local_sync_status.proto:28

The sync status of every locally known experiment.

message MkrSciBleSensorConfig

mkrsci_sensor_config.proto:27

message PictureLabelValue

picture_label_value.proto:30

A value that can be stored in the proto_data field of label.proto, to store data about a picture. Added in V2.

message Pin

sensor.proto:73

Pin of a specific type.

Used in: Data, SensorDataRequest

message Range

trial.proto:103

A time range

Used in: Trial

message ScalarSensorData

scalar_sensor_data.proto:31

message ScalarSensorDataDump

scalar_sensor_data.proto:35

Used in: ScalarSensorData

message ScalarSensorDataRow

scalar_sensor_data.proto:41

Used in: ScalarSensorDataDump

message SensorData

sensor.proto:151

message SensorDataRequest

sensor.proto:95

Phone to Device request to initiate sensor data collection and reporting from multiple pins over an interval. The timestamp is used to synchronize the (inaccurate) clock on the device to the (accurate) clock on the phone.

message SensorLayout

sensor_layout.proto:26

Used in: Experiment, Trial

enum SensorLayout.CardView

sensor_layout.proto:32

Used in: SensorLayout

message SensorSpec

sensor_spec.proto:31

Specification of an observable sensor. Added in V2

Used in: Experiment.SensorEntry, SensorTriggerLabelValue, SnapshotLabelValue.SensorSnapshot

message SensorStat

trial.proto:133

Represents a single stat, i.e. average = 42 or num_data_points = 17.

Used in: SensorTrialStats

enum SensorStat.StatType

trial.proto:134

Used in: SensorStat

message SensorTrialStats

trial.proto:115

Trial stats for a single sensor. Each sensor may have multiple individual stats.

Used in: Trial

enum SensorTrialStats.StatStatus

trial.proto:120

Used in: SensorTrialStats

message SensorTrigger

sensor_trigger.proto:31

Represents a sensor trigger. Added in V2.

Used in: Experiment

message SensorTriggerLabelValue

sensor_trigger_label_value.proto:33

A value that can be stored in the proto_data field of label.proto, to store a sensor trigger label's data. Added in V2.

message SketchLabelValue

sketch_label_value.proto:30

A value that can be stored in the proto_data field of label.proto, to store a set of sketched values.

message SnapshotLabelValue

snapshot_label_value.proto:31

A value that can be stored in the proto_data field of label.proto, to store a set of snapshotted values from one or more sensors. Added in V2.

message SnapshotLabelValue.SensorSnapshot

snapshot_label_value.proto:32

Used in: SnapshotLabelValue

message StringValue

sensor.proto:127

StringValue contains a stream of single-dimensional string values synthesized by the Firmware from data collected on the Device.

Used in: Data

message SyncExperiment

experiment_library.proto:37

A single experiment to be synced to Drive. Next Tag: 7

Used in: ExperimentLibrary

message SyncFolder

sync_folder.proto:27

The Drive folder that is used to store synced data

message TextLabelValue

text_label_value.proto:30

A value that can be stored in the proto_data field of label.proto, to store a set of snapshotted values from one or more sensors. Added in V2.

message Trial

trial.proto:35

Trial protobuf definition Added in V2.

Used in: Experiment

message Trial.AppearanceEntry

trial.proto:77

Version 1.2: Added

Used in: Trial

message TriggerInformation

sensor_trigger_information.proto:28

TriggerInformation contains metadata users can set and edit on a particular trigger.

Used in: SensorTrigger, SensorTriggerLabelValue

enum TriggerInformation.TriggerActionType

sensor_trigger_information.proto:43

What type of action should be taken when the trigger fires?

Used in: TriggerInformation

enum TriggerInformation.TriggerAlertType

sensor_trigger_information.proto:53

The type of alert to use when the trigger fires, if this is an TRIGGER_ACTION_ALERT type.

Used in: TriggerInformation

enum TriggerInformation.TriggerWhen

sensor_trigger_information.proto:33

What data pattern causes the trigger to fire?

Used in: TriggerInformation

message UserMetadata

user_metadata.proto:33

Represents metadata shared across the whole Science Journal app for one user. Added in V2.

message Version

sensor.proto:31

(message has no fields)

enum Version.VersionEnum

sensor.proto:36

See https://docs.google.com/document/d/10SgMM-_myVyfZQZ_afLipPv_x4aq4gQG2FTrY3oktXM/edit# for version policy and implementation details. Encode new versions using https://goosci.googlesource.com/android/+/master/proto/version_codec.py

message VirtualPin

sensor.proto:68

Virtual pin refers to a non-physical pin capability on the Device, such as a Gooball orientation sensor that returns vectors of floats.

Used in: Pin