SatVUE Portal LUA Documentation

local epoch = getEpochUTC(message_data['_timestamp_'])
local ydoc_system_message = message_data['_message_']
local dayofweek = formatDateTime(message_data['_timestamp_'], 'N')
local analogInput = message_data['Port1Value']

report_data = {
    start = '2016-12-12 12:12:12',
    end = '2016-12-12 13:12:12',
    data = {
        {
            _timestamp_ = '2016-12-12 12:12:12', -- as defined by report's date format
            field1      = 123,
            field2      = 999
        },
        {
            _timestamp_ => '2016-12-12 13:12:12',
            field1      => 100,
            field2      => 900
        },
        ...
    }
}
								

for key, row in ipairs(report_data['data']) do
    print('Recorded At: '..row['_timestamp_']..' Battery Voltage: '..row['BatteryVoltage']..'\r\n');
end
									

Recorded At: 2017-12-12 09:00:00

string: [Optional] The date/time to format in a string representation to convert. Or current time if this is not set.

Returns an integer representing the number of seconds since midnight January 1, 1970.

local epoch = getEpochUTC();
print 'Epoch: '..epoch

Epoch: 1507615068

string: The date/time to format in a string representation
format: The format to return the date/time in. See here for details.

Returns a string representation of the specified time in the specified format.

local formatted_time = formatDateTime('2017-11-01 09:12:00 +10', 'H:i:sP, jS F, Y')
print 'Time: '..formatted_time

Time: 09:12:00+10:00, 1st November, 2017

epoch: The date/time to format in Epoch format
format: The format to return the date/time in. See here for details.

Returns a string representation of the specified time in the specified format.

local formatted_time = formatEpoch(1509527520, 'H:i:sP, jS F, Y')
print 'Time: '..formatted_time

Time: 09:12:00+10:00, 1st November, 2017

field: The name of the device field to fetch the alarm configuration for.

A table of the following format is returned

{
    enabled = true,                  -- True if the alarm is enabled, false otherwise
    active  = false,                 -- True if the alarm is currently active, false otherwise
    high    = 5.99                   -- The alarm's high threshold
    low     = 1.23                   -- The alarm's low threshold
}

local signal_alarm = getAlarmConfig('Signal Strength')
print 'Signal Strength Alarm: '..signal_alarm['low']..' dB'

Signal Strength Alarm: 42 dB

device: The name or serial of the device to lookup the device field on.
field: The name of the device field to fetch the alarm configuration for.

A table of the following format is returned

{
    enabled = true,                  -- True if the alarm is enabled, false otherwise
    active  = false,                 -- True if the alarm is currently active, false otherwise
    high    = 5.99                   -- The alarm's high threshold
    low     = 1.23                   -- The alarm's low threshold
}

local signal_alarm = getAlarmConfig('Signal Strength')
print 'Signal Strength Alarm: '..signal_alarm['low']..' dB'

Signal Strength Alarm: 42 dB

local device_name = getName()

device: The name or serial of the SatVUE device

local device_name = getNameFromDevice('DEVICE-SERIAL')

local users = getSelectedUsers()

An array of tables containing the following information:

result = [
  {
    first_name  = 'Joe',             -- The users first name
    last_name   = 'Bloggs',          -- The users last name
    email       = 'joe@bloggs.com',  -- The users email address
  },
  {
  ...
  }

device: The name or serial of the SatVUE device

local users = getSelectedUsersFromDevice('DEVICE-SERIAL')

An array of tables containing the following information:

result = [
  {
    first_name  = 'Joe',             -- The users first name
    last_name   = 'Bloggs',          -- The users last name
    email       = 'joe@bloggs.com',  -- The users email address
  },
  {
  ...
  }

getGpsLocation()

device: The name or serial of the SatVUE device

Returns FALSE if the device name could not be found, or TRUE if the message was sent.

if getGpsLocationFromDevice('AnotherSatVUE') then
  print 'Message has been sent'
end

Message has been sent

device: The name or serial of the SatVUE device
field: The name of the field to get

Returns the field's latest value from the specified device, or nil if there is no previous value.

local barometric = getLatestValueFromDevice('AnotherSatVUE', 'Barometric')
print 'Barometric Pressure: '..barometric..' KPa'

Barometric Pressure: 101.1 KPa

field: The name of the field to get
count: The number of samples to fetch

A table of the following format is returned

{
  {
    timestamp = 1509527520,                  -- Timestamp is in Epoch format
    datetime = '2017-11-01 19:12:00 +10',    -- Timestamp is in String format
    value = 1.23                             -- Numeric Field value
  },
  {
    timestamp = 1509527580,
    datetime = '2017-11-01 19:13:00 +10',
    value = 2.12
  },
  ...
  ...
}

local values = getPreviousValues('Water Level', 5)
for i,record in ipairs(values) do
  local epochTimestamp = record.timestamp
  local waterLevel = record.value
  print 'Timestamp: '..formatEpoch(epochTimestamp, 'Y-m-d H:i:s')..' Value: '..
end

...

field: The name of the field to get

Returns the field's latest value from the specified device, or nil if there is no previous value.

local barometric = getLatestValue('Barometric')
print 'Barometric Pressure: '..barometric..' KPa'

Barometric Pressure: 101.1 KPa

device: The name or serial of the SatVUE device

Returns FALSE if the device name could not be found, or TRUE if the message was sent.

if pollDevice('AnotherSatVUE') then
  print 'Poll message has been sent'
end

Poll message has been sent

start: The start date/time in UTC/Epoch format
end: The end date/time in UTC/Epoch format
count: The max number of samples to return

Returns FALSE if the parameters are invalid, or TRUE if the message was sent.

if requestLoggedData(1509527520, 1509529000, 100) then
  print 'Up to 100 records has been requested'
end

Up to 100 records has been requested

port: The digital output port to set, 1 - 4.
value: True to set the output high, or False to set it low

Returns FALSE if the port parameter is invalid, or TRUE if the message was sent.

if setEioOutput(1, true) then
  print 'Message has been sent'
end

Message has been sent

device: The name or serial of the SatVUE device
port: The digital output port to set, 1 - 4.
value: True to set the output high, or False to set it low

Returns FALSE if the port parameter or the device name is invalid, or TRUE if the message was sent.

if setEioOutputOnDevice('AnotherSatVUE', 2, false) then
  print 'Message has been sent'
end

Message has been sent

slave: The modbus slave the IO exapander is on, 1 - 6.
output: The digital output port to set, 1 - 2.
value: True to set the output, or False to clear the output

Returns FALSE if the slave parameter is invalid, or TRUE if the message was sent.

if setDigitalOutput(1, 1, true) then
  print 'Message has been sent'
end

Message has been sent

device: The name of the SatVUE device
slave: The modbus slave the IO exapander is on, 1 - 6.
output: The digital output port to set, 1 - 2.
value: True to set the output, or False to clear the output

Returns FALSE if the slave parameter is invalid, or TRUE if the message was sent.

if setDigitalOutputOnDevice('AnotherSatVUE', 1, 1, true) then
  print 'Message has been sent'
end

Message has been sent

command: A table containing the following data:

command = {
  FunctionCode    = 6,     -- The function code
  SlaveAddress    = 240,   -- The slave address
  RegisterAddress = 34,    -- The register address
  Length          = 1,     -- The register count
  Values          = {1},   -- The register data to write as a binary string
  Timeout         = 1000,  -- The slave timeout
  Retries         = 3,     -- Number of times to retry the modbus request
}

Returns FALSE if the a parameter is invalid, or TRUE if the message was sent.

if sendModbusCmd({
  FunctionCode    = 6,     -- The function code
  SlaveAddress    = 240,   -- The slave address
  RegisterAddress = 34,    -- The register address
  Length          = 1,     -- The register count
  ValueString     = 1,     -- The register data to write as a binary string
  Timeout         = 1000,  -- The slave timeout
  Retries         = 3,     -- Number of times to retry the modbus request
}) then
  print 'Message has been sent'
end

Message has been sent

device: The name or serial of the SatVUE device
command: See sendModbusCmd() for description.

Returns FALSE if the a parameter is invalid, or TRUE if the message was sent.

local command = { ... }
if sendModbusCmd('AnotherSatVUE', command) then
  print 'Message has been sent'
end

Message has been sent

field_name: The name of the field to fetch the alarm configration from.

A table containing the following information:

result = {
  enabled  = 1,     -- Is the alarm enabled
  active   = 1,     -- Is the alarm currently active
  high     = 34,    -- The alarm's high threshold
  low      = 1,     -- The alarm's low threshold
}

local alarm_config = getAlarmConfig('Water Depth')
if alarm_config['active'] then
  print 'The alarm is active'
end

The alarm is active

device: The name of the device to lookup the field on
field_name: The name of the field to fetch the alarm configration from.

A table containing the following information:

result = {
  enabled  = 1,     -- Is the alarm enabled
  active   = 1,     -- Is the alarm currently active
  high     = 34,    -- The alarm's high threshold
  low      = 1,     -- The alarm's low threshold
}

local alarm_config = getAlarmConfigFromDevice('Tank 1', 'Water Depth')
if alarm_config['active'] then
  print 'The alarm is active'
end

The alarm is active

element_name: The name of the key to store the value in the message_data[] structure.
value: The value to insert

Returns TRUE aways.

insertTempValue('field-name', 1.23)

timestamp: The timestamp for the value to be inserted for the Device Field.
field_name: The name of the device field to insert the value for.
value: The value to insert
decimals: [Optional] If the field is created, it will get defined to use this many decimal places.
units: [Optional] If the field is created, it will get defined to use this as it units.

Returns FALSE if the insert failed, or TRUE if it was successful.

if insertValue('2021-01-01 12:00:00', 'field-name', 1.23) then
  print 'Value has been inserted'
end

Value has been inserted

to: The email address to send the message to. Comma seperate multiple addresses.
subject: The subject of the email.
text: The text body of the email message.
html: [Optional] The HTML body of the email message.

Returns FALSE if the email failed to send, or TRUE if it was successful.

local to = 'person@example.com'
local subject = 'This is an email'
local text = 'This is the text part of the email'
local html = 'This is the HTML part of the email'
emailSend(to, subject, text, html)