Feedmixer Solution Guide

// Area - ARS
message Area {
	enum AreaType {
		A_LOADING_POINT = 0;
		A_BARN = 1;
		A_OTHER = 2;
	}

	UUID area_external_id = 1; /// Uniquely references for the area in the sofware system used
	string area_name = 2;      /// Name of the area
	AreaType area_type = 3;    /// Type of the area (LoadingPoint, Barn, other)
	UUID customer_id_ref = 4;  /// Internal reference
	repeated google.protobuf.Any extension = 2048;
}

// Component - CMP
message Component {
	enum ComponentType {
		A_ROUGHAGE = 0;
		A_BY_PRODUCT = 1;
		A_CONCENTRATE = 2;
		A_FRESH_GRASS = 3;
		A_MINERAL = 4;
		A_MEDICATION = 5;
		A_OTHER = 6;
	}

	UUID component_external_id = 1;   /// Uniquely references for the component in the sofware system used
	string component_name = 2;        /// Name of the component
	ComponentType component_type = 3; /// Type of the component
	Nutrients nutrients = 4;          /// Included Nutrients object
	UUID area_id_ref = 5;             /// Internal reference
	repeated google.protobuf.Any extension = 2048;
}

// Customer - CTR
message Customer {

	UUID customer_external_id = 1; /// Uniquely references for the customer in the sofware system used
	string customer_name = 2;      /// Name of the customer
	repeated google.protobuf.Any extension = 2048;
}

// Device - DVC
message Device {

	UUID device_external_id = 1;     /// Uniquely references for the device in the sofware system used
	string device_serial_number = 2; /// Serial number of the device assigned by the manufacturer
	string device_name = 3;          /// Name of the device
	uint64 device_capacity = 4;      /// Total KG capcaity of the mixer (treshold of overload). Unit: *kg*
	repeated UUID area_id_ref = 5;   /// White-List means, list of areas that can be accessed
	repeated google.protobuf.Any extension = 2048;
}

// Group - GRP
message Group {
	enum GroupType {
		A_MILKING = 0;
		A_DRY = 1;
		A_BULLS = 2;
		A_OTHER = 3;
	}

	UUID group_external_id = 1;           /// Uniquely references for the group in the sofware system used
	string group_name = 2;                /// Name of the group
	GroupType group_type = 3;             /// Type of the group (milking, dry, bulls, other)
	uint32 group_head_count = 4;          /// Total number of annimals for this group. : piece
	uint32 group_feeding_factor = 5;      /// Relative percentage used to adjust feed amount for a group. (default 100%).  %
	uint32 group_feeding_rack_length = 6; /// Length of feeding rack of the specific group.  m
	UUID area_id_ref = 7;                 /// Internal reference
	repeated google.protobuf.Any extension = 2048;
}

// Ingredient - ING
message Ingredient {
	enum StartMode {
		A_AUTO = 0;
		A_MANUAL = 1;
		A_OTHER = 2;
	}

	UUID ingredient_external_id = 1;        /// UUID of the ingredient used in the recipe
	UUID component_id_ref = 2;              /// Internal reference
	uint32 ingredient_quantity = 3;         /// Quantity (kg/head) actual load. Unit: kg/head
	uint32 ingredient_order = 4;            /// Loading position/ sequence in load list
	StartMode start_mode = 5;               /// Start mode (auto, maunual, other)
	uint32 ingredient_mix_time = 6;         /// Total mix time expected during or after each ingredient. Unit sec
	uint32 ingredient_mix_speed = 7;        /// Mix speed expected for each ingredient. Unit RPM/min
	uint32 ingredient_mix_rotations = 8;    /// Mix rotations expected for each ingredient. Unit RPM
	uint32 ingredient_start_percentage = 9; /// Starting percentage of the total weight of the current ingredient to start the mixer. Unit %
	repeated google.protobuf.Any extension = 2048;
}

// Nutrients - NUT
message Nutrients {
	double dry_matter = 1; /// Expected dry matter percentage. Unit %
	repeated google.protobuf.Any extension = 2048;
}

// Recipe - RCP
message Recipe {

	UUID recipe_external_id = 1;                                  /// Uniquely references for the recipe in the sofware system used
	string recipe_name = 2;                                       /// Name of the recipe
	uint32 recipe_density = 3;                                    /// Density of specific recipe. Unit kg/m³
	uint32 recipe_revision = 4;                                   /// Progressive ID to identify the different changes applied to the recipe
	bool recipe_premix = 5;                                       /// Flag to tell if the recipe is for a premix
	repeated Ingredient ingredient_ref = 6;                       /// Included Ingredients array (ING)
	AfterLoadingLastIngredient after_loading_last_ingredient = 7; /// Included After loading ingredient (ALI)
	repeated google.protobuf.Any extension = 2048;
}

// AfterLoadingLastIngredient - ALI
message AfterLoadingLastIngredient {
	enum StartMode {
		A_AUTO = 0;
		A_MANUAL = 1;
		A_OTHER = 2;
	}

	StartMode start_mode = 1;
	uint32 afterloadinglastingredient_mix_time = 2;      /// Total mix time expected during or after the last ingredient. Unit sec
	uint32 afterloadinglastingredient_mix_speed = 3;     /// Mix speed expected for the last ingredient. Unit RPM/min
	uint32 afterloadinglastingredient_mix_rotations = 4; /// Mix rotations expected for the last ingredient. Unit RPM
	repeated google.protobuf.Any extension = 2048;
}

message MasterDataResponse {
    enum ResponseCode {
        OK = 0; /// No error occured
        CANNOT_PROCESS_MASTERDATA = 2; /// Given MasterData cannot be processed
    }

    ResponseCode response_code = 1; /// Response code with processing information
    string response_text = 2;       /// Response text with human-readable information on why the MasterData cannot be processed

    repeated google.protobuf.Any extension = 2048;
}

// PlannedLoadListWithDependencies for synchronization
message PlannedLoadListWithDependencies {

    PlannedLoadList plannedLoadList = 1;
    repeated Area area = 2;
    repeated Component component = 3;
    repeated Customer customer = 4;
    repeated Device device = 5;
    repeated Group group = 6;
    repeated Ingredient ingredient = 7;
    repeated Nutrients nutrients = 8;
    repeated Recipe recipe = 9;
    repeated Worker worker = 10;
    repeated google.protobuf.Any extension = 2048;
}

message PlannedLoadListWithDependenciesResponse {
    enum ResponseCode {
        OK = 0;                                             /// No error occured
        CANNOT_PROCESS_PLANNEDLOADLISTWITHDEPENDENCIES = 2; /// Given PlannedLoadListWithDependencies cannot be processed
    }

    ResponseCode response_code = 1; /// Response code with processing information
    string response_text = 2;       /// Response text with human-readable information on why the PlannedLoadListWithDependencies cannot be processed

    repeated google.protobuf.Any extension = 2048;
}

// PlannedLoadList - PLL
message PlannedLoadList {
	enum PlannedLoadListType {
		B_PLANNED = 0;
		B_ADHOC = 1;
		B_OTHER = 2;
	}

	UUID plannedloadlist_id = 1;                             /// Uniquely references for the planned load list in the sofware system used
	PlannedLoadListType plannedloadlist_type = 2;            /// Type of the planned load list (planned, adhoc, other)
	UUID recipe_id_ref = 3;                                  /// Internal reference
	string plannedloadlist_starttime = 4;                    /// Expected start time. Datetime in ISO 8601 representation
	repeated PlannedLoadListGroup plannedloadlist_group = 5; /// Included PlannedLoadListGroup object
	repeated google.protobuf.Any extension = 2048;
}

// PlannedLoadListGroup - internal object
message PlannedLoadListGroup {

	UUID group_id_ref = 1;
	string plannedloadlistgroup_discharge_time = 2; /// Expected start time. Datetime in ISO 8601 representation
	int32 plannedloadlistgroup_order = 3;           /// Order in the list of groups to be fed. Unit piece
	int32 plannedloadlistgroup_feeding_factor = 4;  /// Relative percentage used to adjust feed amount for a group. (default 100%). Unit %
	repeated google.protobuf.Any extension = 2048;
}

message PlannedLoadListResponse {
    enum ResponseCode {
        OK = 0;                             /// No error occured
        CANNOT_PROCESS_PLANNEDLOADLIST = 2; /// Given PlannedLoadList cannot be processed
    }

    ResponseCode response_code = 1; /// Response code with processing information
    string response_text = 2;       /// Response text with human-readable information on why the PlannedLoadList cannot be processed

    repeated google.protobuf.Any extension = 2048;
}

// CompleteLoadListWithDependencies for synchronization.
message CompleteLoadListWithDependencies {

    CompleteLoadList completeLoadList = 1;
    repeated Area area = 2;
    repeated Component component = 3;
    repeated Customer customer = 4;
    repeated Device device = 5;
    repeated Group group = 6;
    repeated Ingredient ingredient = 7;
    repeated Nutrients nutrients = 8;
    repeated Recipe recipe = 9;
    repeated Worker worker = 10;
    repeated google.protobuf.Any extension = 2048;
}

message CompleteLoadListWithDependenciesResponse {
    enum ResponseCode {
        OK = 0;                                              /// No error occured
        CANNOT_PROCESS_COMPLETELOADLISTWITHDEPENDENCIES = 2; /// Given CompleteLoadListWithDependencies cannot be processed
    }

    ResponseCode response_code = 1; /// Response code with processing information
    string response_text = 2;       /// Response text with human-readable information on why the CompleteLoadListWithDependencies cannot be processed

    repeated google.protobuf.Any extension = 2048;
}

// CompleteLoadList - CLL
message CompleteLoadList {

	UUID completeloadlist_external_id = 1;                              /// ID of the CompleteLoadList
	UUID device_id_ref = 2;                                             /// Internal reference
	UUID worker_id_ref = 3;                                             /// Internal reference
	UUID plannedloadlist_id_ref = 4;                                    /// Internal reference
	string completeloadlist_start_time = 5;                             /// Start time the load is executed. Datetime in ISO 8601 representation
	string completeloadlist_end_time = 6;                               /// End time the load is executed. Datetime in ISO 8601 representation
	double completeloadlist_totalTheoreticalQty = 7;                    /// Total programmed quantity. Unit kg
	double completeloadlist_totalQty = 8;                               /// Total real quantity. Unit kg
	repeated CompleteLoadListIngredient completeLoadListIngredient = 9; /// Included CompleteLoadListIngredient object
	repeated CompleteLoadListGroup completeLoadListGroup = 10;          /// Included CompleteLoadListGroup object
	repeated google.protobuf.Any extension = 2048;
}

// CompleteLoadListIngredient - internal object
message CompleteLoadListIngredient {

	UUID ingredient_id_ref = 1;
	string completeloadlistingredient_start_time = 2;    /// Start time of the load of each specific ingrdient. Datetime in ISO 8601 representation
	string completeloadlistingredient_end_time = 3;      /// End time of the load of each specific ingrdient.Datetime in ISO 8601 representation
	int32 completeloadlistingredient_order = 4;          /// Loading position/ sequence in load list. Unit piece
	double completeloadlistingredient_realQty = 5;       /// Total real quantity. Unit kg
	int32 completeloadlistingredient_real_mix_time = 6;  /// Total mix time. Unit sec
	int32 completeloadlistingredient_real_mix_speed = 7; /// Total mix rotations. Unit rpm
	repeated google.protobuf.Any extension = 2048;
}

// CompleteLoadListGroup - internal object
message CompleteLoadListGroup {

	UUID group_id_ref = 1;
	string completeloadlistgroup_start_time = 2;     /// Start time the load is executed. Datetime in ISO 8601 representation
	string completeloadlistgroup_end_time = 3;       /// End time. Datetime in ISO 8601 representation
	double completeloadlistgroup_theoreticalQty = 4; /// Total programmed quantity. Unit kg
	int32 completeloadlistgroup_realQty = 5;         /// Total real quantity. Unit kg
	repeated google.protobuf.Any extension = 2048;
}

message CompleteLoadListResponse {
    enum ResponseCode {
        OK = 0;                              /// No error occured
        CANNOT_PROCESS_COMPLETELOADLIST = 2; /// Given CompleteLoadList cannot be processed
    }

    ResponseCode response_code = 1; /// Response code with processing information
    string response_text = 2;       /// Response text with human-readable information on why the CompleteLoadList cannot be processed

    repeated google.protobuf.Any extension = 2048;
}

// RefusalWithDependencies for synchronization (SYNC verb).
message RefusalWithDependencies {

    Refusal refusal = 1;
    repeated Group group = 2;
    repeated google.protobuf.Any extension = 2048;
}

message RefusalWithDependenciesResponse {
    enum ResponseCode {
        OK = 0;                                      /// No error occured
        CANNOT_PROCESS_REFUSALWITHDENPENDENCIES = 2; /// Given RefusalWithDependencies cannot be processed
    }

    ResponseCode response_code = 1; /// Response code with processing information
    string response_text = 2;       /// Response text with human-readable information on why the RefusalWithDependencies cannot be processed

    repeated google.protobuf.Any extension = 2048;
}

// Refusal - RFL
message Refusal {

	UUID refusal_external_id = 1; /// Uniquely references for the refusal in the sofware system used
	UUID group_id_ref = 2;        /// Internal reference
	string refusal_time = 3;      /// Time of collection. Datetime in ISO 8601 representation
	double refusal_totalQty = 4;  /// Quantity (kg/lb/etc..) of refused collected. Unit kg
	repeated google.protobuf.Any extension = 2048;
}

message RefusalResponse {
    enum ResponseCode {
        OK = 0;                     /// No error occured
        CANNOT_PROCESS_REFUSAL = 2; /// Given Refusal cannot be processed
    }

    ResponseCode response_code = 1; /// Response code with processing information
    string response_text = 2;       /// Response text with human-readable information on why the Refusal cannot be processed

    repeated google.protobuf.Any extension = 2048;
}