Controller Method


The controller method allows you to access your account controller settings.

Base Url

GET   http://www.reefware.com/api/request/v1/controller

Response

{ id: [controller_id],
tank: [tank_token],
brand: [controller_brand],
system: [controller_model],
host: [host_url],
port: [port_number],
alk: [alkalinity_on_off],
calc: [calcium_on_off],
mag: [magnesium_on_off],
temp: [temperature_on_off],
ammo: [ammonia_on_off],
ph: [ph_on_off],
salt: [specific_gravity_on_off],
nitrite: [nitrite_on_off],
nitrate: [nitrate_on_off],
phos: [phosphate_on_off]
}


Data Options

id
optional

  • 'id' will return the controller settings id.
  • The controller settings id is unique and specific to each controller.
  • This option will result in a returned number.

tank
optional

  • 'tank' will return the tank token that this controller is associated with.
  • The tank token will be required to update the controller settings.
  • This option will return a string.

brand
optional

  • 'brand' will return the brand of the controller.
  • The available brands include Digital Aquatics (da), Neptune (neptune), and Reef Angel (ra).
  • This option will return a string.

system
optional

  • 'system' will return the model of the controller.
  • This option will return a string.

host
optional

  • 'host' will return the ip address or website url for the controller.
  • This option will return numbers or a url.

port
optional

  • 'port' will return the port being used to access the controller.
  • This option will return a number.

alk
optional

  • 'alk' will return the status of the alkalinity probe.
  • This option will return a zero or one.
  • '0' means the probe is not in use.
  • '1' means the probe is in use.

calc
optional

  • 'calc' will return the status of the calcium probe.
  • This option will return a zero or one.
  • '0' means the probe is not in use.
  • '1' means the probe is in use.

mag
optional

  • 'mag' will return the status of the magnesium probe.
  • This option will return a zero or one.
  • '0' means the probe is not in use.
  • '1' means the probe is in use.

temp
optional

  • 'temp' will return the status of the temperature probe.
  • This option will return a zero or one.
  • '0' means the probe is not in use.
  • '1' means the probe is in use.

ammo
optional

  • 'ammo' will return the status of the ammonia probe.
  • This option will return a zero or one.
  • '0' means the probe is not in use.
  • '1' means the probe is in use.

ph
optional

  • 'ph' will return the status of the pH probe.
  • This option will return a zero or one.
  • '0' means the probe is not in use.
  • '1' means the probe is in use.

salt
optional

  • 'salt' will return the status of the specific graity or salinity probe.
  • This option will return a zero or one.
  • '0' means the probe is not in use.
  • '1' means the probe is in use.

nitrite
optional

  • 'nitrite' will return the status of the nitrite probe.
  • This option will return a zero or one.
  • '0' means the probe is not in use.
  • '1' means the probe is in use.

nitrate
optional

  • 'nitrate' will return the status of the nitrate probe.
  • This option will return a zero or one.
  • '0' means the probe is not in use.
  • '1' means the probe is in use.

phos
optional

  • 'phos' will return the status of the phosphate probe.
  • This option will return a zero or one.
  • '0' means the probe is not in use.
  • '1' means the probe is in use.

 

Example Request

GEThttp://www.reefware.com/api/request/v1/controller/data/tank.brand.port

Response

  1. [
  2. [
  3. {
  4. "tank": "TDYSu837akslCjd902K",
  5. "brand": "neptune",
  6. "port": 8181
  7. }
  8. ]
  9. ]