GreenLight_Extensions

Matlab extensions for the GreenLight - A model for greenhouses with supplemental lighting , including setParamVal and glObjToJson.

Table of Contents

• Installation
• Usage
• Example
• Functions
• License

Installation

Download the repository to your local machine.

git clone https://github.com/greenpeer/GreenLight_Extensions.git

Usage

gl is an instance of the GreenLight model, To generate a gl instance using GreenLight, you can run the runGreenLight.m file located in the runScenarios folder of the GreenLightrepository.

json_str = glObjToJson(gl)

The setParamVal function changes the value of a parameter in a DynamicModel object. cFruit is a parameter name used in gl objects. It is located under the gl object.x namespace.

setParamVal(gl, "x","cFruit", 2.8e5)

Example

Consider a MATLAB object gl with nested structures, instances of custom classes, such as DynamicModel, DynamicElement, and function handles:

Calls the runGreenLight function from MATLAB with the specified lamp type, season, filename, parameters, crop maturity and return values.

gl = runGreenLight(lampType, season, filename, paramNames, paramVals, isMature)

To convert this gl object to a JSON string, simply call the glObjToJson function:

json_data = glObjToJson(gl)

The sample resulting JSON string json_data will be:

{
  "x": {
    "co2Air": {
      "label": "x.co2Air",
      "def": "@(x,a,u,d,p)(1/(p.capCo2Air))*(a.mcBlowAir+a.mcExtAir+a.mcPadAir-(a.mcAirCan)-(a.mcAirTop)-(a.mcAirOut))",
      "val": [
        [0, 811.57497020754624],
        [300, 811.75447291764658]
      ]
    }
  },
  "a": {
    "tauShScrPar": {
      "label": "a.tauShScrPar",
      "def": "@(x,a,u,d,p)1-((u.shScr)*(1-(p.tauShScrPar)))",
      "val": [
        [0, 1],
        [300, 1]
      ]
    },
    "tauShScrPerPar": {
      "label": "a.tauShScrPerPar",
      "def": "@(x,a,u,d,p)1-((u.shScrPer)*(1-(p.tauShScrPerPar)))",
      "val": [
        [0, 1],
        [300, 1]
      ]
    }
  },
  "d": {
    "iGlob": {
      "label": "d.iGlob",
      "def": "@(x,a,u,d,p)d.iGlob",
      "val": [
        [0, 0],
        [300, 0]
      ]
    }
  },
  "p": {
    "alfaLeafAir": {
      "label": "p.alfaLeafAir",
      "def": "@(x,a,u,d,p)p.alfaLeafAir",
      "val": 5
    },
    "L": {
      "label": "p.L",
      "def": "@(x,a,u,d,p)p.L",
      "val": 2.45e6
    },
    "sigma": {
      "label": "p.sigma",
      "def": "@(x,a,u,d,p)p.sigma",
      "val": 5.67e-8
    },
    "epsCan": {
      "label": "p.epsCan",
      "def": "@(x,a,u,d,p)p.epsCan",
      "val": 1
    }
  },
  "u": {
    "boil": {
      "label": "0+1.*(1./(1+exp(((-2./(p.tHeatBand)).*4.6052).*(x.tAir-(a.heatSetPoint)-((p.tHeatBand)/2)))))",
      "def": "@(x,a,u,d,p)0+1.*(1./(1+exp(((-2./(p.tHeatBand)).*4.6052).*(x.tAir-((max(((((p.lampsOn)~=(p.lampsOff)).*(((p.lampsOn)<(p.lampsOff)).*(min(max(0,min(1,24*(x.time-(floor(x.time)))-(p.lampsOn)+1)),max(0,min(1,p.lampsOff-(24*(x.time-(floor(x.time))))+1))))+(1-((p.lampsOn)<(p.lampsOff))).*(max(max(0,min(1,24*(x.time-(floor(x.time)))-(p.lampsOn)+1)),max(0,min(1,p.lampsOff-(24*(x.time-(floor(x.time))))+1)))))).*((d.dayRadSum)<(p.lampRadSumLimit))).*((((p.dayLampStart)<=(p.dayLampStop)).*(((p.dayLampStart)<(mod(x.time,365.2425)))&((mod(x.time,365.2425))<(p.dayLampStop)))+(1-((p.dayLampStart)<=(p.dayLampStop))).*(((p.dayLampStart)<(mod(x.time,365.2425)))|((mod(x.time,365.2425))<(p.dayLampStop)))).*1),d.isDay))*(p.tSpDay)+(1-(max(((((p.lampsOn)~=(p.lampsOff)).*(((p.lampsOn)<(p.lampsOff)).*(min(max(0,min(1,24*(x.time-(floor(x.time)))-(p.lampsOn)+1)),max(0,min(1,p.lampsOff-(24*(x.time-(floor(x.time))))+1))))+(1-((p.lampsOn)<(p.lampsOff))).*(max(max(0,min(1,24*(x.time-(floor(x.time)))-(p.lampsOn)+1)),max(0,min(1,p.lampsOff-(24*(x.time-(floor(x.time))))+1)))))).*((d.dayRadSum)<(p.lampRadSumLimit))).*((((p.dayLampStart)<=(p.dayLampStop)).*(((p.dayLampStart)<(mod(x.time,365.2425)))&((mod(x.time,365.2425))<(p.dayLampStop)))+(1-((p.dayLampStart)<=(p.dayLampStop))).*(((p.dayLampStart)<(mod(x.time,365.2425)))|((mod(x.time,365.2425))<(p.dayLampStop)))).*1),d.isDay)))*(p.tSpNight)+(p.heatCorrection)*((((1.*((d.iGlob)<(p.lampsOffSun))).*((d.dayRadSum)<(p.lampRadSumLimit))).*((((p.lampsOn)<=(p.lampsOff)).*(((p.lampsOn)<(24*(x.time-(floor(x.time)))))&((24*(x.time-(floor(x.time))))<(p.lampsOff)))+(1-((p.lampsOn)<=(p.lampsOff))).*(((p.lampsOn)<(24*(x.time-(floor(x.time)))))|((24*(x.time-(floor(x.time))))<(p.lampsOff)))).*1)).*((((p.dayLampStart)<=(p.dayLampStop)).*(((p.dayLampStart)<(mod(x.time,365.2425)))&((mod(x.time,365.2425))<(p.dayLampStop)))+(1-((p.dayLampStart)<=(p.dayLampStop))).*(((p.dayLampStart)<(mod(x.time,365.2425)))|((mod(x.time,365.2425))<(p.dayLampStop)))).*1)))-((p.tHeatBand)/2)))))",
      "val": [
        [0, 0.0099006978376994809],
        [300, 0.99999982425931389]
      ]
    }
  },
  "c": [],
  "g": [],
  "t": {
    "label": "10-Jan-2005 01:00:00",
    "def": [],
    "val": [0, 300.00000223517418]
  },
  "e": []
}

You can then save this JSON string to a file, or use it in other applications that work with JSON data.

Functions

1. encodeNestedObj(obj): Encodes a nested MATLAB object into a new object, coverts its function handles to string.
2. encodeFieldValue(fieldName, fieldValue): Encodes a field value based on its name and type. It handles various data types such as function handles, empty values, structures, and instances of the DynamicElement class.
3. glObjToJson(gl): The main function that converts a custom MATLAB object gl to a JSON string.
4. The setParamVal function changes the value of a parameter in a DynamicModel object. It throws an error if the DynamicElement of dm.x.<name> doesn't exist.

---

glObjToJson

json_str = glObjToJson(gl);

Convert a custom MATLAB object "gl" to a JSON string.

Inputs:

• gl: A MATLAB GreenLight model object that may have nested structures, instances of the DynamicModel or DynamicElement class, function handles, or other field types.

Outputs:

• json_str: A JSON string representation of the input object gl, with all function handles in gl converted to strings.

---

encodeNestedObj

encodedObj = encodeNestedObj(obj);

Encode a nested MATLAB object into a new object.

Inputs:

• obj: A MATLAB object that may have nested structures, instances of the DynamicModel or DynamicElement class, function handles, or other field types.

Outputs:

• encodedObj: An encoded representation of the input object "obj".

---

encodeFieldValue

encodedValue = encodeFieldValue(fieldName, fieldValue);

Encode a field value based on its name and type.

Inputs:

• fieldName: The name of the field to be encoded.
• fieldValue: The value of the field to be encoded.

Outputs:

• encodedValue: The encoded value of the input field value.

---

setParamVal

setParamVal(dm, attrib, name, val)

Inputs:

• dm: A DynamicModel object.
• attrib: A string specifying the attribute of the parameter to be changed. It can be either 'x' or 'p'.
• name: A string specifying the name of the parameter to be changed.
• val: A numeric value that will replace the current value of the specified parameter.

Outputs:

• None

---

Limitations

• The glObjToJson function is designed to work with GreenLight model MATLAB objects that have nested structures, instances of the DynamicModel or DynamicElement class, function handles, and other field types. However, it may not handle other possible MATLAB data types or custom classes.
• The function currently assumes that function handles are only present in fields named 'def'. If you have function handles with different field names, you may need to modify the encodeFieldValue function accordingly.
• The function may not handle very large or complex objects efficiently.

License

This project is licensed under the MIT License .