vrt-lss-agro 7.37.3331

VRt.Agro [AG]

vrt_lss_agro

Programming interface for Veeroute Agro.

Description

The service is designed to compute the work plan of production facilities.

General schema

Field

• produces a specific agricultural crop with a specific moisture level
• crop output from the field can be moved only to an Elevator or a Plant

Elevator (Threshing floor)

• consists of Gates, Dryers, short-term and long-term storage locations
• dries the grain (if the crop moisture is above the allowed level)
• stores dry grain in short-term storage locations (warehouses); unloading and loading of grain within a single day is allowed
• stores dry grain in long-term storage locations (sleeves, trenches, mounds)
• only one type of crop can be stored in a single storage at a time
• sells surplus grain to the Market
• production processes inside the facility: drying, loading/unloading to a storage location, storage

Plant

• consists of Gates, Dryers, Bunkers, Consumers
• [if drying is present] dries the grain (if the crop moisture is above the allowed level)
• stores dry grain in Bunkers (short-term storage tied to a specific crop)
• maintains a minimum stock of grain in Bunkers for consumption
• consumes grain from Bunkers
• buys missing grain from the Market
• production processes inside the facility: drying, loading/unloading to a storage location, storage, consumption

Market

• buys grain from Elevators
• sells grain to Plants

Project

A project reflects the planned sequence of operations on agricultural crops; the operation types are described below.

HARVEST

Harvesting of an agricultural crop:

• between production facilities (a Field and an Elevator or a Plant)
• the operation occurs within a single day
• grain moisture is determined at the Field

	Object (target_key)	Sub-object (target_detail_key)
Source	Field	-
Destination	Elevator or Plant	Gates

DRY

Drying of a crop:

• inside a production facility (Elevator or Plant)
• duration of the operation — one day
• during drying both the mass and the moisture type change (WET -> DRY)
• the source specifies the mass of the wet crop
• the destination specifies the resulting mass of the dry crop

	Object (target_key)	Sub-object (target_detail_key)
Source	Elevator or Plant	Gates
Destination	Elevator or Plant	Dryer

LOAD

Loading of a crop from the Gates into a Storage location (long-term, short-term, bunker):

• between parts of the same production facility (Elevator or Plant)
• the operation occurs within a single day

	Object (target_key)	Sub-object (target_detail_key)
Source	Elevator or Plant	Gates or Dryer
Destination	Elevator or Plant	Storage location (long-term, short-term, bunker)

UNLOAD

Unloading of a crop from a storage location to the Gates:

• between parts of the same production facility (Elevator)
• the operation occurs within a single day

	Object (target_key)	Sub-object (target_detail_key)
Source	Elevator	Storage location (long-term, short-term, bunker) or Dryer
Destination	Elevator	Gates

STORE

Crop storage:

• the storage location does not change
• duration of the operation — one day
• the operation occurs overnight

	Object (target_key)	Sub-object (target_detail_key)
Source	Elevator or Plant	Storage location (long-term, short-term, bunker)
Destination	Elevator or Plant	The same storage location

RELOCATE

Transport between production facilities:

• between production facilities (Elevator and Plant)
• the operation occurs within a single day

	Object (target_key)	Sub-object (target_detail_key)
Source	Elevator	Gates
Destination	Plant	Gates

CONSUMPTION

Consumption of a crop by the plant:

• between parts of the same production facility (Plant)
• the operation occurs within a single day
• consumption goes from a Bunker
• additionally we can consume directly from the Gates or the Dryer without storing in a Bunker

	Object (target_key)	Sub-object (target_detail_key)
Source	Plant	Bunker or Gates or Dryer
Destination	Plant	Consumer

SELL

Sale of a crop:

• between production facilities (Elevator and Market)
• the operation occurs within a single day

	Object (target_key)	Sub-object (target_detail_key)
Source	Elevator	Gates
Destination	Market	Contract

BUY

Purchase of a crop:

• between production facilities (Market and Plant)
• the operation occurs within a single day

	Object (target_key)	Sub-object (target_detail_key)
Source	Market	Contract
Destination	Plant	Gates

Entity diagram

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 7.37.3331
• Package version: 7.37.3331
• Generator version: 7.17.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import vrt_lss_agro

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import vrt_lss_agro

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import vrt_lss_agro
from vrt_lss_agro.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.edge7.veeroute.cloud
# See configuration.py for a list of all supported configuration parameters.
configuration = vrt_lss_agro.Configuration(
    host = "https://api.edge7.veeroute.cloud"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): ApiKeyAuth
configuration = vrt_lss_agro.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with vrt_lss_agro.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vrt_lss_agro.PlanApi(api_client)
    process_code = 'process_code_example' # str | Unique process identifier.

    try:
        # Cancel calculation
        api_instance.cancel_plan_calculation(process_code)
    except ApiException as e:
        print("Exception when calling PlanApi->cancel_plan_calculation: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.edge7.veeroute.cloud

Class	Method	HTTP request	Description
PlanApi	cancel_plan_calculation	DELETE /agro/plan/calculation-async/{process_code}	Cancel calculation
PlanApi	delete_plan_result	DELETE /agro/plan/result/{process_code}	Result removal
PlanApi	read_algo_data	GET /agro/plan/data/{process_code}	Algo data
PlanApi	read_plan_result	GET /agro/plan/result/{process_code}	Getting the result
PlanApi	read_plan_state	GET /agro/plan/state/{process_code}	Calculation state
PlanApi	run_plan_calculation	POST /agro/plan/calculation	Planning (SYNC)
PlanApi	run_plan_calculation_async	POST /agro/plan/calculation-async	Planning (ASYNC)
PlanApi	run_plan_clip	POST /agro/plan/clip/{clip_key}	Clipping (SYNC)
PlanApi	run_plan_validation	POST /agro/plan/validation	Data validation
SystemApi	check	GET /agro/system/check	Checking the availability
SystemApi	file	GET /agro/file/{filename}	Getting the documentation
SystemApi	version	GET /agro/system/version	Getting the service version

Documentation For Models

• Agro400WithErrorsAndWarnings
• AgroEntityError
• AgroEntityErrorType
• AgroEntityPath
• AgroEntityType
• AgroEntityWarning
• AgroEntityWarningType
• AgroPlanResult
• AgroPlanSettings
• AgroPlanStatistics
• AgroPlanTask
• AgroUnplannedItems
• AgroValidateResult
• Attribute
• Bunker
• CalculationAsyncResult
• CalculationInfo
• CalculationSettings
• CalculationState
• CalculationStatus
• CapacityForecastElement
• Chamber
• CheckResult
• Consumer
• Contract
• ContractType
• CostForecastElement
• Crop
• CropType
• DateWindow
• Dryer
• Elevator
• Factory
• FlowType
• Gate
• General400
• General402
• General403
• General404
• General404Detail
• General429
• General500
• HumidityForecastElement
• Leftover
• ManufacturingOperation
• Market
• ModelField
• MovementMatrixElement
• ObjectType
• OperationMeasurements
• OperationTarget
• OperationType
• PriceForecastElement
• Pricelist
• ProductivityForecastElement
• ProjectConfiguration
• ProjectSettings
• SchemaError
• Service
• Silo
• StockForecastElement
• Storage
• Tracedata
• VersionResult

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: Bearer authentication (JWT)

Author

[e-mail]