Skip to content

Commit aadacf7

Browse files
authored
Update feedmixer-solution-guide.adoc
Removed some typos
1 parent 3f116ae commit aadacf7

File tree

1 file changed

+45
-44
lines changed

1 file changed

+45
-44
lines changed

modules/ROOT/pages/feedmixer-solution-guide.adoc

Lines changed: 45 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Supported languages include the following:
2727
2828
[#compile-feedmixer-protobuf]
2929
== Compile the Feedmixer Protocol Buffers schema
30-
The feedmixer data structures are defined in ``.proto-`` files, you can generate the classes needed to read and write the protobuf messages. To do this, use the protocol buffers compiler (protoc) on the configuration file. +
30+
The Feedmixer data structures are defined in ``.proto-`` files, you can generate the classes needed to read and write the protobuf messages. To do this, use the protocol buffers compiler (protoc) on the configuration file. +
3131
If the compiler is not yet installed, simply download the latest version from the official https://github.com/protocolbuffers/protobuf/releases/[GitHub repository, window="_blank"]. Unpack the ZIP file at the desired location and then start the compiler by double-clicking (located in the ``"bin"`` folder).
3232
3333
[NOTE]
@@ -54,9 +54,9 @@ Google offers a more detailed Protobuf Java tutorial, which also explains messag
5454
====
5555
5656
[#feedmixer_objects]
57-
== Description of the feedmixer objects
57+
== Description of the Feedmixer objects
5858
59-
Overview of feed mixer objects
59+
Overview of Feedmixer objects
6060
[cols="1,1"]
6161
|===
6262
|link:#area[``area``]
@@ -69,7 +69,7 @@ Overview of feed mixer objects
6969
|Description of the customer
7070
7171
|link:#device[``Device``]
72-
|Description of a feed mixer wagon
72+
|Description of a Feedmixer wagon
7373
7474
|link:#group[``Group``]
7575
|Description of an animal group
@@ -107,13 +107,13 @@ Overview of feed mixer objects
107107
|link:#plannedloadlistresponse[``PlannedLoadListResponse``]
108108
|Processing status of the transmitted load list
109109
110-
|link:#completeloadlistwithdependencies[``CompleteLoadListWithDependencies``].
110+
|link:#completeloadlistwithdependencies[``CompleteLoadListWithDependencies``]
111111
|Description of the actual state of a load list.
112112
113113
|link:#completeloadlistwithdependenciesresponse[``CompleteLoadListWithDependenciesResponse``]
114114
|Processing status of the transferred actual status for a load list.
115115
116-
|link:#completeloadlist[``CompleteLoadList``]]
116+
|link:#completeloadlist[``CompleteLoadList``]
117117
|Description of the actual state of a load list.
118118
119119
|link:#completeloadlistingredient[``CompleteLoadListIngredient``]
@@ -138,7 +138,7 @@ Overview of feed mixer objects
138138
|Processing status of the transmitted feed refusal.
139139
|===
140140
141-
Most objects contain a ``UUID`` which uniquely refers to an ID in the software system used. In most cases, the object is also described by a ``(string)`` name.
141+
Most objects contain an ``UUID`` which uniquely refers to an ID in the software system used. In most cases, the object is also described by a ``(string)`` name.
142142
143143
[source]
144144
-----------------
@@ -234,11 +234,11 @@ message Customer {
234234
-----------------
235235
236236
[#device]
237-
==== Feed mixer wagon
238-
Description of a feed mixer wagon ``(Device)``.
237+
==== Feedmixer wagon
238+
Description of a Feedmixer wagon ``(Device)``.
239239
240240
In addition to the name ``(device_name)`` of the serial number ``(device_serial_number)``, the load capacity ``(device_capacity)`` is described in the unit *kg*. +
241-
The possible loading and unloading points for this feed mixer wagon are specified via a *white list* ``(repeated UID area_id_ref)``.
241+
The possible loading and unloading points for this Feedmixer wagon are specified via a *white list* ``(repeated UID area_id_ref)``.
242242
243243
[source]
244244
-----------------
@@ -256,8 +256,9 @@ message Device {
256256
257257
[#group]
258258
==== Animal group
259-
Description of an animal group ``(Group)`` the animal group type is described via the ``GroupType ``.
259+
Description of an animal ``(Group)``.
260260
261+
The animal group-type is described via the ``GroupType ``.
261262
The number of animals in this animal group is specified via the parameter: ``(group_head_count )`` in the unit *piece*. +
262263
The relative percentage for adjusting the feed quantity (default value 100%) is determined via the factor ``(group_feeding_factor)`` in the unit *%*. +
263264
The length of the feeding rack (in *m*) of this animal group is described by the parameter ``group_feeding_rack_length``. +
@@ -391,7 +392,7 @@ message AfterLoadingLastIngredient {
391392
392393
[#masterdata]
393394
=== Master data, synchronization
394-
The master data/master data can be synchronized via this object. +
395+
The master data can be synchronized via this object. +
395396
This procedure is described via the scenario flow ``(Sync MasterData)``.
396397
397398
[source]
@@ -601,13 +602,13 @@ message CompleteLoadListWithDependenciesResponse {
601602
-----------------
602603
603604
[#completeloadlist]
604-
==== Completed feed list
605+
==== Completed load list
605606
The ``CompleteLoadList`` object is used to describe the actual status of a ``PlannedLoadList``.
606607
607-
The feed mixer used is referenced via the parameter ``device_id_ref``, the same applies to the employee via ``worker_id_ref``. +
608+
The Feedmixer used is referenced via the parameter ``device_id_ref``, the same applies to the employee via ``worker_id_ref``. +
608609
The underlying load list is referenced via ``plannedloadlist_id_ref``. +
609610
The start and end time is specified via ``completeloadlist_start_time`` and ``completeloadlist_end_time`` respectively. +
610-
The planned feeding quantity in the unit *kg* is returned via the parameter ``completeloadlist_totalTheoreticalQty`` and the quantity actually fed (*kg*) via the parameter ``completeloadlist_totalQty``.+
611+
The planned feeding quantity in the unit *kg* is returned via the parameter ``completeloadlist_totalTheoreticalQty`` and the quantity actually fed (*kg*) via the parameter ``completeloadlist_totalQty``.
611612
The actual filling and mixing process for each ingredient is described in the ``completeLoadListIngredient`` list of object type ``CompleteLoadListIngredient``. +
612613
The animal groups that were fed with this load are configured via the ``completeLoadListGroup`` list of the ``CompleteLoadListGroup`` object type.
613614
@@ -678,7 +679,7 @@ message CompleteLoadListGroup {
678679
-----------------
679680
680681
[#completeloadlistresponse]
681-
==== Response object for a completed feed list
682+
==== Response object for a completed load list
682683
The ``CompleteLoadListResponse`` object is used to return the processing status for a transmitted ``CompleteLoadList`` via the ``response_code``.
683684
684685
@@ -804,9 +805,9 @@ The most important features of the concept are
804805
The standardized definition of data and processes allows different systems to work together seamlessly, regardless of manufacturer or software environment. This promotes interoperability and scalability for small and large companies.
805806
806807
- **Examples of scenario flows**
807-
- Planning process:** Creation of a ration plan in the herd management system, transmission of the data to the feed mixer, feedback of the measures carried out.
808-
- Real-time monitoring:** Collection of sensor data (e.g. weather station), evaluation in real time and automated adjustment of measures.
809-
- Documentation:** Automatic recording of machine data during field work and integration into legal documentation requirements.
808+
- **Planning process:** Creation of a ration plan in the herd management system, transmission of the data to the Feedmixer, feedback of the measures carried out.
809+
- **Real-time monitoring:** Collection of sensor data (e.g. weather station), evaluation in real time and automated adjustment of measures.
810+
- **Documentation:** Automatic recording of machine data during field work and integration into legal documentation requirements.
810811
811812
- **Integration and extension**
812813
Scenario Flows can be adapted to specific needs and technologies while maintaining compatibility with other standards and systems.
@@ -817,11 +818,11 @@ The most important features of the concept are
817818
- **Flexibility:** Ability to integrate new technologies and use cases.
818819
- **Cost reduction:** Standardized interfaces reduce development and integration costs for manufacturers and companies.
819820
820-
== Possible scenarios Flows in the FeedMixer context
821+
== Possible scenarios Flows in the Feedmixer context
821822
822823
[cols="1,1"]
823824
|===
824-
|link:#flow-masterdata[``Scenario Flow: Sync Masterdata``]]
825+
|link:#flow-masterdata[``Scenario Flow: Sync Masterdata``]
825826
|Scenario Flow: Synchronization of master data
826827
827828
|link:#flow-plannedloadlist[``Scenario Flow: PlannedLoadList``]
@@ -831,7 +832,7 @@ The most important features of the concept are
831832
|Scenario Flow: Exchange of a load list with all necessary master data
832833
833834
|link:#flow-completeloadlist[``Scenario Flow: CompleteLoadList``]
834-
|Scenario Flow: Exchange of a completed feed list
835+
|Scenario Flow: Exchange of a completed load list
835836
836837
|link:#flow-completeloadlistwithdependencies[``Scenario Flow: CompleteLoadListWithDependencies``]
837838
|Scenario Flow: Exchange of a completed feeding list with all necessary master data
@@ -843,22 +844,22 @@ The most important features of the concept are
843844
|Scenario Flow: Exchange of a feed refusal with all necessary master data
844845
|===
845846
846-
These scenarios involve creating, managing and exchanging a list of planned loads for a feed mixer wagon between different systems.
847+
These scenarios involve creating, managing and exchanging a list of planned loads for a Feedmixer wagon between different systems.
847848
This typically involves the following steps:
848849
849850
- **Planning of feed rations**: A herd or feed management system creates a detailed feed ration based on the nutritional needs of the animals and available feed resources.
850851
851-
- **Creation of the loading list**: Based on the planned feed ration, a specific loading list is created for the feed mixer wagon, specifying the exact quantities and types of feed to be loaded.
852+
- **Creation of the loading list**: Based on the planned feed ration, a specific loading list is created for the Feedmixer wagon, specifying the exact quantities and types of feed to be loaded.
852853
853-
- **Transmission to the feed mixer**: The loading list created is transmitted electronically to the control system of the feed mixer wagon to control the loading and mixing process.
854+
- **Transmission to the Feedmixer**: The loading list created is transmitted electronically to the control system of the Feedmixer wagon to control the loading and mixing process.
854855
855-
- **Performing the mixing process**: The feed mixer carries out the mixing process according to the loading list received and ensures that the animals receive the planned feed ration.
856+
- **Performing the mixing process**: The Feedmixer carries out the mixing process according to the loading list received and ensures that the animals receive the planned feed ration.
856857
857858
- **Reporting and documentation**: On completion of the mixing and feeding process, the actual quantities of feed loaded and distributed are reported back to the herd or feed management system to document the feeding data and make it available for future analysis.
858859
859860
- **Feed refusal of an animal group**: Feed quantities for an animal group that have been refused can be reported back to the herd or feed management in order to document them and make them available for future analyses.
860861
861-
**These scenarios ensure that the entire process of feed planning, mixing and distribution is carried out efficiently and accurately by enabling seamless communication and data integration between herd or feed management systems and feed mixers.**
862+
**These scenarios ensure that the entire process of feed planning, mixing and distribution is carried out efficiently and accurately by enabling seamless communication and data integration between herd or feed management systems and Feedmixers.**
862863
863864
[NOTE]
864865
====
@@ -878,71 +879,71 @@ The processing status is transmitted to the sender via the ``MasterDataResponse`
878879
879880
[#flow-plannedloadlist]
880881
== Scenario Flow: Exchange of a load list
881-
This scenario flow describes the data exchange of a ``PlannedLoadList``, e.g. from a herd management system to a feed mixer.
882+
This scenario flow describes the data exchange of a ``PlannedLoadList``, e.g. from a herd management system to a Feedmixer.
882883
The status of the processing is transmitted to the sender via the ``PlannedLoadListResponse`` object.
883884
884-
In the first step, the receiver (feed mixer) attempts to resolve the references of the required objects via its stored objects.
885+
In the first step, the receiver (Feedmixer) attempts to resolve the references of the required objects via its stored objects.
885886
If this is successful, ``OK`` is used as the ``ResponseCode`` for the ``PlannedLoadListResponse`` and successful processing is acknowledged.
886887
887888
However, if one or more references could not be resolved, ``CANNOT_PROCESS_PLANNEDLOADLIST`` is used as the ``ResponseCode`` for the ``PlannedLoadListResponse``.
888-
This signals to the sender (herd management system) that necessary master data is missing on the feed mixer wagon and a synchronization of the master data must be triggered.
889+
This signals to the sender (herd management system) that necessary master data is missing on the Feedmixer wagon and a synchronization of the master data must be triggered.
889890
See also: link:#flow-masterdata[Scenario Flow - Synchronization of master data]
890891
891892
[#flow-plannedloadlistwithdependencies]
892893
== Scenario Flow: Exchange of a load list with all necessary master data
893-
This scenario flow describes the data exchange of a ``PlannedLoadListWithDependencies``, e.g. from a herd management system to a feed mixer.
894+
This scenario flow describes the data exchange of a ``PlannedLoadListWithDependencies``, e.g. from a herd management system to a Feedmixer.
894895
The status of the processing is transmitted to the sender via the object ``PlannedLoadListWithDependenciesResponse``.
895896
896-
In the first step, the receiver (feed mixer) attempts to resolve the references of the necessary objects via its stored objects.
897+
In the first step, the receiver (Feedmixer) attempts to resolve the references of the necessary objects via its stored objects.
897898
If this is successful, ``OK`` is used as the ``ResponseCode`` for the ``PlannedLoadListWithDependenciesResponse``, thus confirming successful processing.
898899
899900
However, if one or more references could not be resolved, ``CANNOT_PROCESS_PLANNEDLOADLISTWITHDEPENDENCIES`` is used as the ``ResponseCode`` for the ``PlannedLoadListWithDependenciesResponse``.
900901
This signals to the sender (herd management system) that the content of the load list is not correct and must be checked/corrected and therefore resent.
901902
902903
[#flow-completeloadlist]
903-
== Scenario Flow: Exchange of a completed feed list
904-
This scenario flow describes the data exchange of a ``CompleteLoadList`` from a feed mixer to the herd or feed agent system.
904+
== Scenario Flow: Exchange of a completed load list
905+
This scenario flow describes the data exchange of a ``CompleteLoadList`` from a Feedmixer to the herd or feed agent system.
905906
The status of the processing is transmitted to the sender via the ``CompleteLoadListResponse`` object.
906907
907908
In the first step, the receiver (herd feed management) attempts to resolve the references of the transmitted objects.
908909
If this is successful, ``OK`` is used as the ``ResponseCode`` in the ``CompleteLoadListResponse``, thus confirming successful processing.
909910
910911
If, however, one or more references could not be resolved, ``CANNOT_PROCESS_COMPLETELOADLIST`` is used as the ``ResponseCode`` for the ``CompleteLoadListResponse``.
911-
This signals to the sender (feed mixer) that necessary master data is missing and a synchronization of the master data must be triggered.
912+
This signals to the sender (Feedmixer) that necessary master data is missing and a synchronization of the master data must be triggered.
912913
See also: link:#flow-masterdata[Scenario Flow - Synchronization of master data]
913914
914915
[#flow-completeloadlistwithdependencies]
915-
== Scenario Flow: Exchange of a completed feed list with all necessary master data
916-
This scenario flow describes the data exchange of a ``CompleteLoadListWithDependencies`` from a feed mixer to a herd or feed agent system.
916+
== Scenario Flow: Exchange of a completed load list with all necessary master data
917+
This scenario flow describes the data exchange of a ``CompleteLoadListWithDependencies`` from a Feedmixer to a herd or feed agent system.
917918
The status of the processing is transmitted to the sender via the ``CompleteLoadListWithDependenciesResponse`` object.
918919
919920
In the first step, the receiver (herd feed management) attempts to resolve the references of the necessary objects via its stored objects.
920921
If this is successful, ``OK`` is used as the ``ResponseCode`` for the ``CompleteLoadListWithDependenciesResponse``, thus confirming successful processing.
921922
922923
However, if one or more references could not be resolved, ``CANNOT_PROCESS_COMPLETELOADLISTWITHDEPENDENCIES`` is used as the ``ResponseCode`` for the ``CompleteLoadListWithDependenciesResponse``.
923-
This signals to the sender (feed mixer) that the content of the completed loading list is not correct. This must be checked and corrected so that it can be resent.
924+
This signals to the sender (Feedmixer) that the content of the completed loading list is not correct. This must be checked and corrected so that it can be resent.
924925
925926
[#flow-refusal]
926927
== Scenario Flow: Exchange of a feed refusal
927-
This scenario flow describes the data exchange of the ``Refusal`` object from a feed mixer to a herd or feed management system.
928+
This scenario flow describes the data exchange of the ``Refusal`` object from a Feedmixer to a herd or feed management system.
928929
The status of the processing is transmitted to the sender via the ``RefusalResponse`` object.
929930
930931
In the first step, the receiver (herd feed management) attempts to resolve the references of the necessary objects via its stored objects.
931932
If this is successful, ``OK`` is used as the ``ResponseCode`` in the ``RefusalResponse``, thus acknowledging successful processing.
932933
933-
However, if one or more references could not be resolved, the ``ResponseCode`` is used as the ``RefusalResponse`` ``CANNOT_PROCESS_REFUSAL``.
934-
This signals to the sender (feed mixer) that the feed refusal content is incorrect. This must be checked and corrected so that it can be resent.
934+
However, if one or more references could not be resolved, ``CANNOT_PROCESS_REFUSAL`` is used as the ``ResponseCode`` for the ``RefusalResponse``.
935+
This signals to the sender (Feedmixer) that the feed refusal content is incorrect. This must be checked and corrected so that it can be resent.
935936
936937
[#flow-refusalwithdependencies]
937938
== Scenario Flow: Exchange of a feed refusal with all necessary master data
938-
This scenario flow describes the data exchange of a ``RefusalWithDependencies`` from a feed mixer to a herd or feed agent system.
939+
This scenario flow describes the data exchange of a ``RefusalWithDependencies`` from a Feedmixer to a herd or feed agent system.
939940
The status of the processing is transmitted to the sender via the ``RefusalWithDependenciesResponse`` object.
940941
941942
In the first step, the receiver (herd feed management) attempts to resolve the references of the necessary objects via its stored objects.
942943
If this is successful, ``OK`` is used as the ``ResponseCode`` in the ``RefusalWithDependenciesResponse``, thus confirming successful processing.
943944
944-
If, however, one or more references could not be resolved, ``ResponseCode`` is used as ``RefusalWithDependenciesResponse`` ``CANNOT_PROCESS_REFUSALWITHDENPENDENCIES``.
945-
This signals to the sender (feed mixer) that the content for feed refusal is not correct. This must be checked and corrected so that it can be resent.
945+
If, however, one or more references could not be resolved, ``CANNOT_PROCESS_REFUSALWITHDENPENDENCIES`` is used as the ``ResponseCode`` for the ``RefusalWithDependenciesResponse``.
946+
This signals to the sender (Feedmixer) that the content for feed refusal is not correct. This must be checked and corrected so that it can be resent.
946947
947948
948949

0 commit comments

Comments
 (0)