Skip to content

Commands.md

Latest commit

 

History

History
165 lines (118 loc) · 4.5 KB

Commands.md

File metadata and controls

165 lines (118 loc) · 4.5 KB
Raw

MeianCommands

Handled message commands

Kind: global constant

MeianCommands.Client ⇒

Login

Kind: static property of MeianCommands
Returns: data response

Param Type Description
uid * user id
pwd * password

MeianCommands.Push ⇒

Push subscribe

Kind: static property of MeianCommands
Returns: data response

Param Type Description
uid * uid for subscription

Push.formatter()

This formats the "Alarm" command response:

<Root>
  <Host>
    <Alarm>
      <Cid>STR,4|3441</Cid>
      <Content>STR,12|M. Partielle</Content>
      <Time>DTA|2018.09.02.01.12.01</Time>
      <Zone>S32,0,99|70</Zone>
      <ZoneName>STR,16|</ZoneName>
      <Name>STR,15|ORION IP2 </Name>
      <Err/>
    </Alarm>
  </Host>
</Root>

Kind: static method of Push

MeianCommands.GetAlarmStatus ⇒

Get current alarm status

Kind: static property of MeianCommands
Returns: data response

MeianCommands.GetArea ⇒

Get area status (Alarm areas used by Focus FC-7688Plus, not working in Meian ST-IVCGT)

Kind: static property of MeianCommands
Returns: data response

Param Type Description
offset * request offset

MeianCommands.SetArea ⇒

Set area status

Kind: static property of MeianCommands
Returns: data response

Param Type Description
numArea * number of aread
status * status (arm, disarm, stay, clear)

MeianCommands.GetByWay ⇒

get sensor status (alarm/open/closed, problem, lowbat, bypass, etc)

Kind: static property of MeianCommands
Returns: data response

Param Type Description
offset * request offset

MeianCommands.GetZone

All zones status (fault, battery, loss, etc)

Kind: static property of MeianCommands

Param Type Description
offset * request offset

MeianCommands.GetLog

List of events recorded in the alarm (arm, disarm, bypass, alert, etc). The list is composed by 512 events and every message contains 2 of them: it may take some time to get the full list

Kind: static property of MeianCommands

Param Type Description
offset * request offset

MeianCommands.GetNet ⇒

Network config (mac address, ip, etc) and alarm name

Kind: static property of MeianCommands
Returns: data response

MeianCommands.SetAlarmStatus ⇒

Set current alarm status

Kind: static property of MeianCommands
Returns: data response

Param Type Description
status * status (arm, disarm, stay, clear)

MeianCommands.SetByWay

Set bypass for sensor

Kind: static property of MeianCommands

Param Type Description
zone * zone index
bypassed * true or false