fk-data.proto

syntax = "proto3";
package fk_data;
option java_package = "org.conservify.fieldkit.data.pb";
option go_package = "gitlab.com/fieldkit/libraries/data-protocol";

message DeviceLocation {
  uint32 enabled = 7;
  uint32 fix = 1;
  int64 time = 2;
  float longitude = 3;
  float latitude = 4;
  float altitude = 5;
  repeated float coordinates = 6;
  uint32 satellites = 8;
  uint32 hdop = 9;
}

message SensorReading {
  uint64 reading = 1;
  int64 time = 2;
  uint32 sensor = 3;
  float value = 4;
}

message LoggedReading {
  uint32 version = 1;
  DeviceLocation location = 2;
  SensorReading reading = 3;
}

message SensorAndValue {
  uint32 sensor = 1;
  oneof calibrated {
    bool calibratedNull = 4;
    float calibratedValue = 2;
  }
  oneof uncalibrated {
    bool uncalibratedNull = 5;
    float uncalibratedValue = 3;
  }
  // value = 2;
  // uncalibrated = 3;
}

message ModuleHeader {
  uint32 manufacturer = 1;
  uint32 kind = 2;
  uint32 version = 3;
}

message ModuleInfo {
  uint32 position = 1;
  uint32 address = 2;
  string name = 3;
  ModuleHeader header = 4;
  Firmware firmware = 5;
  repeated SensorInfo sensors = 6;
  bytes id = 7;
  uint32 flags = 8;
  bytes configuration = 9;
}

message SensorInfo {
  uint32 number = 1;
  string name = 2;
  string unitOfMeasure = 3;
  string uncalibratedUnitOfMeasure = 5;
  uint32 flags = 4;
}

message Firmware {
  string version = 1;
  string build = 2;
  string number = 3;
  uint64 timestamp = 4;
  string hash = 5;
}

message Metadata {
  bytes deviceId = 1;
  int64 time = 2;
  string git = 3;
  string build = 7;
  uint32 resetCause = 4;
  repeated SensorInfo sensors = 5;
  repeated ModuleInfo modules = 6;
  Firmware firmware = 8;
  bytes generation = 9;
  uint64 record = 10;
}

message Status {
  int64 time = 1;
  uint32 uptime = 2;
  float battery = 3;
  uint32 memory = 4;
  uint64 busy = 5;
}

message LogMessage {
  int64 time = 1;
  uint32 uptime = 2;
  uint32 level = 3;
  string facility = 4;
  string message = 5;
}

enum DownloadFlags {
  READING_FLAGS_NONE = 0;
  READING_FLAGS_NOT_RECORDING = 1;
  READING_FLAGS_MANUAL = 2;
}

message SensorGroup {
  uint32 module = 1;
  int64 time = 3;
  repeated SensorAndValue readings = 2;
}

message Readings {
  int64 time = 1;
  uint64 reading = 2;
  uint32 flags = 3;
  uint64 meta = 6;
  uint32 uptime = 7;
  DeviceLocation location = 4;
  repeated SensorGroup sensorGroups = 5;
}

message Interval {
  uint64 start = 1;
  uint64 end = 2;
  uint32 interval = 3;
}

message JobSchedule {
  bytes cron = 1;
  uint32 interval = 2;
  uint32 repeated = 3;
  uint32 duration = 4;
  uint32 jitter = 5;
  repeated Interval intervals = 6;
}

message Schedule {
  JobSchedule readings = 1;
  JobSchedule network = 2;
  JobSchedule lora = 3;
  JobSchedule gps = 4;
}

message Identity {
  string name = 1;
}

enum ConditionFlags {
  CONDITION_FLAGS_NONE = 0;
  CONDITION_FLAGS_RECORDING = 1;
}

message Condition {
  uint32 flags = 1;
  uint32 recording = 2;
}

message NetworkInfo {
  string ssid = 1;
  string password = 2;
  bool create = 3;
  bool preferred = 4;
}

message WifiTransmission {
  string url = 1;
  string token = 2;
  bool enabled = 3;
}

message TransmissionSettings {
  WifiTransmission wifi = 1;
}

message NetworkSettings {
  repeated NetworkInfo networks = 1;
}

message LoraSettings {
  bytes deviceEui = 1;
  bytes appKey = 2;
  bytes joinEui = 3;
  uint32 frequencyBand = 4;
  bytes deviceAddress = 5;
  bytes networkSessionKey = 6;
  bytes appSessionKey = 7;
  uint32 uplinkCounter = 8;
  uint32 downlinkCounter = 9;
  uint32 rxDelay1 = 10;
  uint32 rxDelay2 = 11;
}

enum EventSystem {
  EVENT_SYSTEM_NONE = 0;
  EVENT_SYSTEM_RESTART = 1;
  EVENT_SYSTEM_BATTERY = 2;
  EVENT_SYSTEM_MEMORY = 3;
  EVENT_SYSTEM_SENSOR = 4;
  EVENT_SYSTEM_WIFI = 5;
  EVENT_SYSTEM_LORA = 6;
}

enum Severity {
  SEVERITY_INFO = 0;
  SEVERITY_WARNING = 1;
  SEVERITY_ERROR = 2;
}

message EventDetails {
  bytes data = 1;
  repeated int32 integers = 2;
  repeated float reals = 3;
}

message Event {
  EventSystem system = 1;
  Severity severity = 2;
  uint32 code = 3;
  uint32 time = 4;
  EventDetails details = 5;
  bytes debug = 6;
}

message DataRecord {
  LoggedReading loggedReading = 1;
  Metadata metadata = 2;
  LogMessage log = 3;
  repeated LogMessage logs = 13;
  Status status = 4;
  Readings readings = 5;
  repeated ModuleInfo modules = 6;
  Schedule schedule = 7;
  uint64 meta = 8;
  Identity identity = 9;
  Condition condition = 10;
  LoraSettings lora = 11;
  NetworkSettings network = 12;
  TransmissionSettings transmission = 14;
  repeated Event events = 15;
}

enum SignedRecordKind {
  SIGNED_RECORD_KIND_NONE = 0;
  SIGNED_RECORD_KIND_MODULES = 1;
  SIGNED_RECORD_KIND_SCHEDULE = 2;
  SIGNED_RECORD_KIND_STATE = 3;
  SIGNED_RECORD_KIND_RAW_STATE = 4;
  SIGNED_RECORD_KIND_EVENTS = 5;
  SIGNED_RECORD_KIND_OTHER = 0xff;
}

message SignedRecord {
  SignedRecordKind kind = 1;
  int64 time = 2;
  bytes data = 3;
  bytes hash = 4;
  uint64 record = 5;
}

message LoraRecord {
  bytes deviceId = 1;
  int64 time = 2;
  uint64 number = 3;
  uint32 module = 4;
  uint64 sensor = 5;
  repeated float values = 6;
  bytes data = 7;
}

enum CurveType {
  CURVE_NONE = 0;
  CURVE_LINEAR = 1;
  CURVE_POWER = 2;
  CURVE_LOGARITHMIC = 3;
  CURVE_EXPONENTIAL = 4;
}

message CalibrationPoint {
  repeated float references = 1;
  repeated float uncalibrated = 2;
  repeated float factory = 3;
  repeated bytes adc = 4;
}

message CalibrationCoefficients {
  repeated float values = 1;
}

message Calibration {
  CurveType type = 1;
  uint32 time = 2;
  uint32 kind = 6;
  repeated CalibrationPoint points = 3;
  CalibrationCoefficients coefficients = 4;
  Firmware firmware = 5;
}

message ModuleConfiguration {
  Calibration calibration = 1; // DEPRECATED
  repeated Calibration calibrations = 2;
}