Mayur,
1) The code will need to be written in Lua, as the Edge MicroServer what handles any property updates from the Lua Script Resources running on the devices.
If you take a look at the "example.lua" file in the "microserver\etc\custom\templates\" directory, you can see an example of how an InfoTable is being populated with data, and then a service is defined that can be bound to the Thing on the ThingWorx server to populate the property.
If you want the property to be automatically pushed you will need to look at the "generator.lua" file in the "microserver\etc\thingworx\lua\handlers\ directory". Properties are given a "functionType" and in the "read" function in the "generator.lua" file the different function types are being handled. The property definition for this would look like so:
properties.Random_Number = { baseType="NUMBER", pushType="NEVER", handler="generator", functionType="random", minValue=0, maxValue=100, qualityPercent=90, errorQualityStatus="BAD" }
To build an InfoTable with a custom service that can be bound and invoked from the RemoteThing in ThingWorx, review the following:
- You will need to define the InfoTable property:
properties.Pushed_InMemory_InfoTable = { baseType="INFOTABLE", pushType="VALUE", dataShape="AllPropertyBaseTypes" }
- You will need to define a DataShape:
dataShapes.AllPropertyBaseTypes (
{ name = "Boolean", baseType = "BOOLEAN" },
{ name = "Datetime", baseType = "DATETIME" },
{ name = "GroupName", baseType = "GROUPNAME" },
{ name = "HTML", baseType = "HTML" },
{ name = "Hyperlink", baseType = "HYPERLINK" },
{ name = "Image", baseType = "IMAGE" },
{ name = "Imagelink", baseType = "IMAGELINK" },
{ name = "Integer", baseType = "INTEGER" },
{ name = "Json", baseType = "JSON" },
{ name = "Location", baseType = "LOCATION" },
{ name = "MashupName", baseType = "MASHUPNAME" },
{ name = "MenuName", baseType = "MENUNAME" },
{ name = "Number", baseType = "NUMBER" },
{ name = "Query", baseType = "QUERY" },
{ name = "String", baseType = "STRING" },
{ name = "Text", baseType = "TEXT" },
{ name = "ThingName", baseType = "THINGNAME" },
{ name = "UserName", baseType = "USERNAME" },
{ name = "XML", baseType = "XML" }
)
- Define a service handler for the service to populate the InfoTable property:
serviceDefinitions.Push_InfoTable (
input { name="value", baseType="INFOTABLE", description="", aspects={dataShape="AllPropertyBaseTypes" } },
output { baseType="INFOTABLE", description="", aspects={dataShape="AllPropertyBaseTypes"} },
description { "Used to push a value to platform." }
)
- The final step is to define a service that will populate the property:
services.Push_InfoTable = function(me, headers, query, data)
if not data.value then
return 400, "You must provide the 'value' parameter"
end
local success, error
-- Have to create an InfoTable for property that we want to set
tw_mutex.lock()
local ds = DataShape.AllPropertyBaseTypes:clone()
tw_mutex.unlock()
local propIt = tw_infotable.createInfoTable(ds)
for _,row in pairs(data.value.rows) do
success, err = propIt:addRow(row)
if err then return 400, err end
end
-- Now, place the prop InfoTable into a container InfoTable
local ds = tw_datashape.createDataShape("Pushed_InMemory_InfoTable", "INFOTABLE", nil, {dataShape="AllPropertyBaseTypes"})
local it = tw_infotable.createInfoTable(ds)
success, err = it:addRow({Pushed_InMemory_InfoTable = propIt})
if err then return 400, err end
me:setProperty("Pushed_InMemory_InfoTable", nil, nil, it:toTable())
return 200, propIt
end
2) You need to bind the properties at the Thing level
