Vidhiii1711's picture
feat: Smart Farm Irrigation Environment with real weather API
e7729e5
Raw History Blame Contribute Delete
2.87 kB
# Copyright (c) Meta Platforms, Inc. and affiliates.
# All rights reserved.
#
# This source code is licensed under the BSD-style license found in the
# LICENSE file in the root directory of this source tree.
"""Smart Farm Irrigation Environment Client."""
from typing import Dict
from openenv.core import EnvClient
from openenv.core.client_types import StepResult
from openenv.core.env_server.types import State
from .models import FarmAction, FarmObservation
class FarmEnv(
EnvClient[FarmAction, FarmObservation, State]
):
"""
Client for the Smart Farm Irrigation Environment.
This client maintains a persistent WebSocket connection to the
environment server, enabling efficient multi-step interactions.
Each client instance has its own dedicated environment session.
Example:
>>> with FarmEnv(base_url="http://localhost:8000") as client:
... result = client.reset()
... result = client.step(FarmAction(water_amount="medium"))
... print(result.observation.crop_health)
"""
def _step_payload(self, action: FarmAction) -> Dict:
"""
Convert FarmAction to JSON payload for step message.
Args:
action: FarmAction instance
Returns:
Dictionary representation suitable for JSON encoding
"""
return {
"water_amount": action.water_amount.value,
}
def _parse_result(self, payload: Dict) -> StepResult[FarmObservation]:
"""
Parse server response into StepResult[FarmObservation].
Args:
payload: JSON response data from server
Returns:
StepResult with FarmObservation
"""
obs_data = payload.get("observation", {})
observation = FarmObservation(
temperature=obs_data.get("temperature", 30.0),
rainfall=obs_data.get("rainfall", 0.0),
soil_moisture=obs_data.get("soil_moisture", None),
crop_health=obs_data.get("crop_health", "fair"),
day_number=obs_data.get("day_number", 1),
crop_stage=obs_data.get("crop_stage", "seedling"),
done=payload.get("done", False),
reward=payload.get("reward"),
metadata=obs_data.get("metadata", {}),
)
return StepResult(
observation=observation,
reward=payload.get("reward"),
done=payload.get("done", False),
)
def _parse_state(self, payload: Dict) -> State:
"""
Parse server response into State object.
Args:
payload: JSON response from state request
Returns:
State object with episode_id and step_count
"""
return State(
episode_id=payload.get("episode_id"),
step_count=payload.get("step_count", 0),
)