Luup Requests

2012-05-08T23:18:29Z

Micasaverde: /* finddevice */

[[Category:Development]]
In addition to sending requests using standard UPnP, you can also do most things using a simple HTTP requests. Use the built-in URL <tt>data_request</tt>, and pass the following on the URL:
*<tt>id</tt> the id of the request (prior to 15 Oct 2010 all requests had an lu_ in front, which is now optional),
*<tt>output_format</tt> the format in which you want a response as <tt>json</tt>, <tt>xml</tt> or <tt>text</tt>.

Not all requests support all <tt>output_format</tt> options. Here is a list of requests:

==user_data==

Example: http://ipaddress:3480/data_request?id=user_data&output_format=xml

This returns the configuration data for Vera, which is a list of all devices and the UPnP variables which are persisted between resets as well as rooms, names, and other data the user sets as part of the configuration.

==status==

Example: http://ipaddress:3480/data_request?id=status&output_format=xml

Or for a specific device: http://ipaddress:3480/data_request?id=status&output_format=xml&UDN=uuid:4d494342-5342-5645-0002-000000000002 or http://ipaddress:3480/data_request?id=status&output_format=xml&DeviceNum=6

This returns the current status for all devices including all the current upnp variables and the status of any active jobs.

==sdata==

This is an abbreviated form of user_data and status (sdata=summary data). It allows a user interface that is only worried about control, and not detailed configuration, to get a summary of the data that would normally be presented to the user and to monitor the changes. See [[UI_Simple]] for a walkthrough.

==actions==

==device==

Example: http://ipaddress:3480/data_request?id=device&action=rename&device=5&name=Chandalier&room=3

Example: http://ipaddress:3480/data_request?id=device&action=rename&device=5&name=Chandalier&room=Garage

Example: http://ipaddress:3480/data_request?id=device&action=delete&device=5

This renames or deletes a device. Use action=rename or action=delete. For rename, you can optionally assign a room by either passing either the ID or the name.

---old---
This returns all the XML with all the UPNP device description documents. Use: http://ipaddress:3480/data_request?id=device&output_format=xml&DeviceNum=x or &UDN=y to narrow it down. Then when you see the service URL's, like <SCPDURL>/luvd/S_HVAC_UserOperatingMode1.xml</SCPDURL>, you can view them with: http://ipaddress:3480/luvd/S_HVAC_UserOperatingMode1.xml
---end old---

==scene==

Example: http://ipaddress:3480/data_request?id=scene&action=record

Example: http://ipaddress:3480/data_request?id=scene&action=pause&seconds=y

Example: http://ipaddress:3480/data_request?id=scene&action=stoprecord

Example: http://ipaddress:3480/data_request?id=scene&action=listrecord

Example: http://ipaddress:3480/data_request?id=scene&action=deleterecord&number=x

Example: http://ipaddress:3480/data_request?id=scene&action=saverecord&name=whatever&room=X

Example: http://ipaddress:3480/data_request?id=scene&action=rename&scene=5&name=Chandalier&room=Garage

Example: http://ipaddress:3480/data_request?id=scene&action=delete&scene=5

Example: http://ipaddress:3480/data_request?id=scene&action=create&json=[valid json data]

Example: http://ipaddress:3480/data_request?id=scene&action=list&scene=5

This creates, renames, or deletes a scene depending on the action.

Recording a scene means whatever actions come in after sending the 'record' will be saved into an internal buffer. listrecord shows what's recorded so far. pause adds a pause. deleterecord deletes some action in the internal buffer. When deleting, for number=x, use the same 'id' in listrecord. saverecord takes the internal buffer, the recorded macro, and saves it as an actual scene.

To create a scene by hand, rather than recording it, use 'create'. When using the 'create' command json must be valid JSON for a scene as documented in [[Scene_Syntax]]. The name, room and optional id (if you're overwriting an existing scene) are passed in the json, so nothing is on the command line except the json. Because the json data can be long it is recommended to send it as an http POST instead of GET with the data passed with the name "json"

list returns the JSON data for an existing scene.

==room==

Example: http://ipaddress:3480/data_request?id=room&action=create&name=Kitchen

Example: http://ipaddress:3480/data_request?id=room&action=rename&room=5&name=Garage

Example: http://ipaddress:3480/data_request?id=scene&action=delete&room=5

This creates, renames, or deletes a room depending on the action. To rename or delete a room you must pass the room id for the room=.

==file==

==lua==

== action ==

Example: http://ipaddress:3480/data_request?id=action&output_format=xml&DeviceNum=6&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=1

Sends a UPnP action.

To run a scene, you send the action 'RunScene' like this::

http://ipadress:3480/data_request?id=lu_action&serviceId=urn:micasaverde-com:serviceId:HomeAutomationGateway1&action=RunScene&SceneNum=<SceneNum>

==variableset==

http://ip:3480/data_request?id=variableset&DeviceNum=6&serviceId=urn:micasaverde-com:serviceId:DoorLock1&Variable=Status&Value=1

If you leave off the DeviceNum and serviceID, then this sets a top-level json tag called "Variable" with the value.

==variableget==

http://ip:3480/data_request?id=variableget&DeviceNum=6&serviceId=urn:micasaverde-com:serviceId:DoorLock1&Variable=Status

If you leave off the DeviceNum and serviceID, then this gets a top-level json tag called "Variable".

==reload==

Resets the Luup engine with any new configuration settings.

==alive==

Return OK if the engine is running.

==finddevice==

Returns the '''device number''', '''UDN''' and '''device type''' of the first device that matches any or all the parameters passed on the URL: <tt>devtype</tt>, <tt>ip</tt>, <tt>devid</tt>, where <tt>devid</tt> is the ''altid'' of the device. Or instead of devid, pass <tt>devnum</tt> and it will find the device with that id (device number).

Example: http://192.168.81.1:3480/data_request?id=finddevice&devid=6

==resync==

ReSync's all the devices, rooms, users, sections with event servers and returns OK

==wget==

Returns the contents of the URL you pass in the "url" argument. Optionally append "user" and "pass" arguments for http authentication, and "timeout" to specify the maximum time to wait in seconds.

==iprequests==

Returns the recent IP requests in order by most recent first, including information about devices in use and if the IP is blacklisted (ignored by the plug and play mechanism). Optionally append "oldest" to specify the oldest IP request in seconds.

==blacklistip==

Append "ip" to the URL, and optionally "remove=1" to add (or remove) the IP to the blacklist so plug and play IP devices won't be added.

Not implemented yet!

==live_energy_usage==

For backward compatibility, it reports the current energy usage in a tab delimited format.

Example: http://192.168.81.1:3480/data_request?id=live_energy_usage

'''Device #''' '''Name''' '''Room''' '''Category''' '''Watts'''
59 Basement Light Basement 3 20
60 Bedroom Light 1st Floor 3 0
61 Porch Light Outside 3 30

== request_image ==

'''NOTE:''' request_video is not implemented yet.


Returns an image from a camera. This fetches the image from the camera using the URL variable for the device. Pass arguments:

cam = the device id of the camera. This is the only mandatory argument.
res = optional: a resolution, which gets appended to the variable. So passing "low" means the image from the URL_low variable will be returned. If it doesn't exist it reverts to the standard URL or DirectStreamingURL
timeout = optional: how long to wait for the image to be retrieved, or how long to retrieve video. defaults to 10 seconds.
url = optional: override the camera's default URL
ip = optional: override the camera's default ip
user or pass = optional: override the camera's default username/password

==jobstatus==

Returns the status of a job. The parameters are <tt>job</tt>, which is the job ID and optionally <tt>plugin</tt>, which is the plugin name. For a Z-Wave job the <tt>plugin</tt> parameter '''must''' be ''zwave''.

If <tt>job</tt> is invalid the status returned is ''-1''.

This is the list with all job statuses and their meaning:

* '''-1''': No job, i.e. job doesn't exist.
* '''0''': Job waiting to start.
* '''1''': Job in progress.
* '''2''': Job error.
* '''3''': Job aborted.
* '''4''': Job done.
* '''5''': Job waiting for callback. Used in special cases.
* '''6''': Job requeue. If the job was aborted and needs to be started, use this special value.
* '''7''': Job in progress with pending data. This means the job is waiting for data, but can't take it now.

Examples:

http://192.168.81.1:3480/data_request?id=jobstatus&job=13

http://192.168.81.1:3480/data_request?id=jobstatus&job=6&plugin=zwave

==invoke==

==relay==

This tells the system to setup a relay so that you can access a device on the home network from outside the home. This is most commonly used to fetch streaming video from a camera, although it can actually be used for any IP device. This takes either an 'ip' or 'device' argument. If you pass a device, this is assumed to be a device ID, and the system will find the ip associated with that device. Optionally pass a port argument for the port you want to be relayed. Port 80 is assumed if none is specified.

This request will return a 'server:port' which you can use externally to access the designated device. The relay stays open for 15 minutes before closing, at which point you will need to open it again.

So, assume you have a NAS device on the home network with the ip 192.168.1.55 and the NAS runs a configuration web page on port 80. You could access it by doing this:

data_request?ip=192.168.1.55&port=80

and if the response is: "someserver:20202", then for 15 minutes, "http://someserver:20202" will be the NAS's configuration page.

If you want to access a camera, device #5, then do this:

data_request?device=5

and if the response is "someserver:20211" and if the 'DirectStreamURL' variable (or 'streaming' in sdata) is "video.mpeg", then for 15 minutes you can access the camera's video at: http://someserver:20211/video.mpeg

Note that if the device, the camera in this case, has http authentication, you will need to pass this too. So, if the user_data or sdata for the camera shows the user name is 'johndoe' and the password is 'john123', then you can view the video at: http://john:john123@someserver:20211/video.mpeg

IMPORTANT: For the 15 minutes while this relay is open, it will be open to anyone on the internet and public. Therefore, for security, you may want to add to the data_request the argument externalip=x where x is the routable, external IP, such as 70.182.172.111, of the device that will be accessing the port. This means that when the relay is open, a firewall will be set on the relay server so that incoming connections are only accepted from that ip address.

==What to do when the HTTP request string is too long==

http://forum.micasaverde.com/index.php/topic,10170.msg69530.html#msg69530

Luup Requests

2012-05-08T23:16:52Z

Micasaverde: /* finddevice */

[[Category:Development]]
In addition to sending requests using standard UPnP, you can also do most things using a simple HTTP requests. Use the built-in URL <tt>data_request</tt>, and pass the following on the URL:
*<tt>id</tt> the id of the request (prior to 15 Oct 2010 all requests had an lu_ in front, which is now optional),
*<tt>output_format</tt> the format in which you want a response as <tt>json</tt>, <tt>xml</tt> or <tt>text</tt>.

Not all requests support all <tt>output_format</tt> options. Here is a list of requests:

==user_data==

Example: http://ipaddress:3480/data_request?id=user_data&output_format=xml

This returns the configuration data for Vera, which is a list of all devices and the UPnP variables which are persisted between resets as well as rooms, names, and other data the user sets as part of the configuration.

==status==

Example: http://ipaddress:3480/data_request?id=status&output_format=xml

Or for a specific device: http://ipaddress:3480/data_request?id=status&output_format=xml&UDN=uuid:4d494342-5342-5645-0002-000000000002 or http://ipaddress:3480/data_request?id=status&output_format=xml&DeviceNum=6

This returns the current status for all devices including all the current upnp variables and the status of any active jobs.

==sdata==

This is an abbreviated form of user_data and status (sdata=summary data). It allows a user interface that is only worried about control, and not detailed configuration, to get a summary of the data that would normally be presented to the user and to monitor the changes. See [[UI_Simple]] for a walkthrough.

==actions==

==device==

Example: http://ipaddress:3480/data_request?id=device&action=rename&device=5&name=Chandalier&room=3

Example: http://ipaddress:3480/data_request?id=device&action=rename&device=5&name=Chandalier&room=Garage

Example: http://ipaddress:3480/data_request?id=device&action=delete&device=5

This renames or deletes a device. Use action=rename or action=delete. For rename, you can optionally assign a room by either passing either the ID or the name.

---old---
This returns all the XML with all the UPNP device description documents. Use: http://ipaddress:3480/data_request?id=device&output_format=xml&DeviceNum=x or &UDN=y to narrow it down. Then when you see the service URL's, like <SCPDURL>/luvd/S_HVAC_UserOperatingMode1.xml</SCPDURL>, you can view them with: http://ipaddress:3480/luvd/S_HVAC_UserOperatingMode1.xml
---end old---

==scene==

Example: http://ipaddress:3480/data_request?id=scene&action=record

Example: http://ipaddress:3480/data_request?id=scene&action=pause&seconds=y

Example: http://ipaddress:3480/data_request?id=scene&action=stoprecord

Example: http://ipaddress:3480/data_request?id=scene&action=listrecord

Example: http://ipaddress:3480/data_request?id=scene&action=deleterecord&number=x

Example: http://ipaddress:3480/data_request?id=scene&action=saverecord&name=whatever&room=X

Example: http://ipaddress:3480/data_request?id=scene&action=rename&scene=5&name=Chandalier&room=Garage

Example: http://ipaddress:3480/data_request?id=scene&action=delete&scene=5

Example: http://ipaddress:3480/data_request?id=scene&action=create&json=[valid json data]

Example: http://ipaddress:3480/data_request?id=scene&action=list&scene=5

This creates, renames, or deletes a scene depending on the action.

Recording a scene means whatever actions come in after sending the 'record' will be saved into an internal buffer. listrecord shows what's recorded so far. pause adds a pause. deleterecord deletes some action in the internal buffer. When deleting, for number=x, use the same 'id' in listrecord. saverecord takes the internal buffer, the recorded macro, and saves it as an actual scene.

To create a scene by hand, rather than recording it, use 'create'. When using the 'create' command json must be valid JSON for a scene as documented in [[Scene_Syntax]]. The name, room and optional id (if you're overwriting an existing scene) are passed in the json, so nothing is on the command line except the json. Because the json data can be long it is recommended to send it as an http POST instead of GET with the data passed with the name "json"

list returns the JSON data for an existing scene.

==room==

Example: http://ipaddress:3480/data_request?id=room&action=create&name=Kitchen

Example: http://ipaddress:3480/data_request?id=room&action=rename&room=5&name=Garage

Example: http://ipaddress:3480/data_request?id=scene&action=delete&room=5

This creates, renames, or deletes a room depending on the action. To rename or delete a room you must pass the room id for the room=.

==file==

==lua==

== action ==

Example: http://ipaddress:3480/data_request?id=action&output_format=xml&DeviceNum=6&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=1

Sends a UPnP action.

To run a scene, you send the action 'RunScene' like this::

http://ipadress:3480/data_request?id=lu_action&serviceId=urn:micasaverde-com:serviceId:HomeAutomationGateway1&action=RunScene&SceneNum=<SceneNum>

==variableset==

http://ip:3480/data_request?id=variableset&DeviceNum=6&serviceId=urn:micasaverde-com:serviceId:DoorLock1&Variable=Status&Value=1

If you leave off the DeviceNum and serviceID, then this sets a top-level json tag called "Variable" with the value.

==variableget==

http://ip:3480/data_request?id=variableget&DeviceNum=6&serviceId=urn:micasaverde-com:serviceId:DoorLock1&Variable=Status

If you leave off the DeviceNum and serviceID, then this gets a top-level json tag called "Variable".

==reload==

Resets the Luup engine with any new configuration settings.

==alive==

Return OK if the engine is running.

==finddevice==

Returns the '''device number''', '''UDN''' and '''device type''' of the first device that matches any or all the parameters passed on the URL: <tt>devtype</tt>, <tt>ip</tt>, <tt>devid</tt>, where <tt>devid</tt> is the ''altid'' of the device. Or instead of devid, pass <tt>id</tt> and it will find the device with that id (device number).

Example: http://192.168.81.1:3480/data_request?id=finddevice&devid=6

==resync==

ReSync's all the devices, rooms, users, sections with event servers and returns OK

==wget==

Returns the contents of the URL you pass in the "url" argument. Optionally append "user" and "pass" arguments for http authentication, and "timeout" to specify the maximum time to wait in seconds.

==iprequests==

Returns the recent IP requests in order by most recent first, including information about devices in use and if the IP is blacklisted (ignored by the plug and play mechanism). Optionally append "oldest" to specify the oldest IP request in seconds.

==blacklistip==

Append "ip" to the URL, and optionally "remove=1" to add (or remove) the IP to the blacklist so plug and play IP devices won't be added.

Not implemented yet!

==live_energy_usage==

For backward compatibility, it reports the current energy usage in a tab delimited format.

Example: http://192.168.81.1:3480/data_request?id=live_energy_usage

'''Device #''' '''Name''' '''Room''' '''Category''' '''Watts'''
59 Basement Light Basement 3 20
60 Bedroom Light 1st Floor 3 0
61 Porch Light Outside 3 30

== request_image ==

'''NOTE:''' request_video is not implemented yet.


Returns an image from a camera. This fetches the image from the camera using the URL variable for the device. Pass arguments:

cam = the device id of the camera. This is the only mandatory argument.
res = optional: a resolution, which gets appended to the variable. So passing "low" means the image from the URL_low variable will be returned. If it doesn't exist it reverts to the standard URL or DirectStreamingURL
timeout = optional: how long to wait for the image to be retrieved, or how long to retrieve video. defaults to 10 seconds.
url = optional: override the camera's default URL
ip = optional: override the camera's default ip
user or pass = optional: override the camera's default username/password

==jobstatus==

Returns the status of a job. The parameters are <tt>job</tt>, which is the job ID and optionally <tt>plugin</tt>, which is the plugin name. For a Z-Wave job the <tt>plugin</tt> parameter '''must''' be ''zwave''.

If <tt>job</tt> is invalid the status returned is ''-1''.

This is the list with all job statuses and their meaning:

* '''-1''': No job, i.e. job doesn't exist.
* '''0''': Job waiting to start.
* '''1''': Job in progress.
* '''2''': Job error.
* '''3''': Job aborted.
* '''4''': Job done.
* '''5''': Job waiting for callback. Used in special cases.
* '''6''': Job requeue. If the job was aborted and needs to be started, use this special value.
* '''7''': Job in progress with pending data. This means the job is waiting for data, but can't take it now.

Examples:

http://192.168.81.1:3480/data_request?id=jobstatus&job=13

http://192.168.81.1:3480/data_request?id=jobstatus&job=6&plugin=zwave

==invoke==

==relay==

This tells the system to setup a relay so that you can access a device on the home network from outside the home. This is most commonly used to fetch streaming video from a camera, although it can actually be used for any IP device. This takes either an 'ip' or 'device' argument. If you pass a device, this is assumed to be a device ID, and the system will find the ip associated with that device. Optionally pass a port argument for the port you want to be relayed. Port 80 is assumed if none is specified.

This request will return a 'server:port' which you can use externally to access the designated device. The relay stays open for 15 minutes before closing, at which point you will need to open it again.

So, assume you have a NAS device on the home network with the ip 192.168.1.55 and the NAS runs a configuration web page on port 80. You could access it by doing this:

data_request?ip=192.168.1.55&port=80

and if the response is: "someserver:20202", then for 15 minutes, "http://someserver:20202" will be the NAS's configuration page.

If you want to access a camera, device #5, then do this:

data_request?device=5

and if the response is "someserver:20211" and if the 'DirectStreamURL' variable (or 'streaming' in sdata) is "video.mpeg", then for 15 minutes you can access the camera's video at: http://someserver:20211/video.mpeg

Note that if the device, the camera in this case, has http authentication, you will need to pass this too. So, if the user_data or sdata for the camera shows the user name is 'johndoe' and the password is 'john123', then you can view the video at: http://john:john123@someserver:20211/video.mpeg

IMPORTANT: For the 15 minutes while this relay is open, it will be open to anyone on the internet and public. Therefore, for security, you may want to add to the data_request the argument externalip=x where x is the routable, external IP, such as 70.182.172.111, of the device that will be accessing the port. This means that when the relay is open, a firewall will be set on the relay server so that incoming connections are only accepted from that ip address.

==What to do when the HTTP request string is too long==

http://forum.micasaverde.com/index.php/topic,10170.msg69530.html#msg69530

AlternateEventServer

2012-05-08T22:34:17Z

Micasaverde:

2012-04-25T19:46:18Z

Micasaverde: Created page with "Place Vera in Add Device mode. On the GE Remote, press and hold Setup until the display reads "Light Setup". Press the right arrow until it says "Transfer". Press OK. Press t..."

GE ZW5301 45631

2012-04-25T03:41:24Z

Micasaverde:

The GE ZW5301 / 45631 is a wall-mountable Z-Wave scene controller. Be sure to remove the tabs behind the battery.

In Vera, go into 'add device' mode. On the scene controller, hold the add and remove buttons until the orange led blinks twice, then immediately press the four 'scene off / down' buttons in order from top to bottom. If the device doesn't add, try doing a factory reset on it by pressing and holding both the left side (OFF) of the #1 Group/Scene button (upper left) and the "Remove" button until the Green LED blinks twice (approx 3-6 seconds).

GE ZW5301 45631

2012-04-25T03:37:57Z

Micasaverde: Created page with "The GE ZW5301 / 45631 is a wall-mountable Z-Wave scene controller. Be sure to remove the tabs behind the battery. In Vera, go into 'add device' mode. On the scene controller, ..."

Serial Supported Hardware

2012-04-04T15:53:54Z

Micasaverde: /* USB Devices */

[[Category:User Instructions]]
[[Category:Hardware]]
This page is not yet complete...

=Introduction=
This is a page for Supported USB, or USB-Serial, interface devices.

USB, and USB-Serial, devices need to be recognized by Vera's platform before they can be used to interface with the target device (through a Luup Module). There are many USB-Serial devices out there, and not all will work out of the gate.

This page is intended to capture the list of known USB Devices that have been ''tried'' with Vera, along with their current status, and any information required to get them working.

This is a wiki, so feel free to add to the page.

=Disclaimer=
'''IMPORTANT! The devices listed here have been added by installers, technicians and users like yourself. Results may vary upon installations. MiCasaVerde does not guarantee operation and compatibility with your installation. The listed devices were found to work with their specific installation. Mixing different series and brands of equipment is not guaranteed in any way to work with other series and brands. It is very likely that users have not fully tested all features of the devices, so it is possible that a device listed here as compatible, will not prove compatible with your hardware. If you are editing this wiki DO NOT REMOVE a listed working device if it hasn't worked for you. Seek help to get the device to work under your individual circumstance. If you are adding to this wiki, please provide links to data for the device and add any tips you feel may benefit someone wanting to implement the device into an installation.'''

= USB Devices =

{| cellpadding="2" border="1" style="width: 1220px;"
|-
! Manufacturer
! Model #
! Status
! Date Purchased
! Chipset
! Specs
! Purchased from
! Added by User
! Notes
|-
| USB-UIRT
| USB-UIRT
| Working (1.0.918)
|
|
| http://www.usbuirt.com/
| http://www.usbuirt.com/
| [http://forum.micasaverde.com/index.php?action=profile;u=2 micasaverde]
|
|-
| APC
| Back-UPS ES 750
| Not Working
|
| APC HID
|
|
| [http://forum.micasaverde.com/index.php?action=profile;u=2618 guessed]
| Doesn't work in Vera 1.0.900. Requires installation of Kernel/OpenWRT modules to support USB-HID Interface for UPS. This one is listed in guessed's posting [http://forum.micasaverde.com/index.php?topic=1471.msg5570#msg5570]
|}

= USB-Serial Devices =

{| border="1" cellpadding="2" width="1220"
|-
! Manufacturer
! Model #
! Status
! Date Purchased
! #RS-232 Ports
! Chipset
! Specs
! Purchased from
! Added by User
! Notes
|-
| Future Electronics
| UC232R-10
| Working
|
| 1
| FTDI
| [http://www.ftdichip.com/Documents/DataSheets/Modules/DS_UC232R.pdf Link]
| [http://www.futureelectronics.com/en/Technologies/Product.aspx?ProductID=UC232R10FUTURETECHNOLOGYDEVICES2297802 futureelectronics.com]
| [http://forum.micasaverde.com/index.php?action=profile;u=2 micasaverde]
| This one is listed in MiCasaVerde's posting [http://forum.micasaverde.com/index.php?topic=1170.msg4500#msg4500]
|-
| SerialGear
| 8XDB9-USB
| Not working
|
| 8
| FTDI - FT8U232AM
| [http://www.ftdichip.com/Documents/DataSheets/ft232r08.pdf Link]
| [http://www.usbgear.com/computer_cable_details.cfm?sku=8XDB9-USB&cats=199&catid=199%2C478%2C474 usbgear.com]
| [http://forum.micasaverde.com/index.php?action=profile;u=525 nanckekr]
| This one is listed in nanckekr's posting [http://forum.micasaverde.com/index.php?topic=1170.msg4484#msg4484] Uses some sort of "dual" FTDI Chipset that causes Vera to lockup. The OS is correctly recognizing the Chip, and all 8x Serial ports, but Vera's "Serial Port Config" isn't working correctly against it as it's using a naming strategy that creates duplicate names.
|-
| Bytecc
| BT-DB925
| Manual
|
| 1
| Prolific - PL-2303
|
| [http://www.monoprice.com/products/product.asp?c_id=103&cp_id=10311&cs_id=1031104&p_id=2067&seq=1&format=2 monoprice.com]
| [http://forum.micasaverde.com/index.php?action=profile;u=2618 guessed]
| This one is listed in guessed's posting [http://forum.micasaverde.com/index.php?topic=1471.msg5512#msg5512]. It requires a series of manual configuration steps, and OS-Level access to Vera, to get it working.
|-
| BAFO
| DX SKU 5947
| Manual
|
| 1
| Prolific - PL-2303
| N/A
| [http://www.dealextreme.com/details.dx/sku.5947 dealextreme.com]
| [http://forum.micasaverde.com/index.php?action=profile;u=7 325xi]
| Well built, recognized by OpenWrt, Ubuntu, Windows, etc. On Vera it will require manual edits made through SSH. See details on nanckekr's post: [http://forum.micasaverde.com/index.php?topic=3025.msg12329#msg12329]
|-
| N/A
| DX SKU 22407
| Not working
|
| 1
| Prolific - PL-2303
| N/A
| [http://www.dealextreme.com/details.dx/sku.22407 dealextreme.com]
| [http://forum.micasaverde.com/index.php?action=profile;u=7 325xi]
| Intermittent USB recognition errors on Vera; but does work on Kamikaze
|-
|
SYBA

| N/A
| Not working
|
| 1
| Prolific - PL-2303
| N/A
| [http://www.monoprice.com/products/product.asp?c_id=103&cp_id=10311&cs_id=1031104&p_id=2276&seq=1&format=2 monoprice.com]
| [http://forum.micasaverde.com/index.php?action=profile;u=7 325xi]
| USB recognition errors on Linux distros and OpenWRT
|-
|  SerialStuff*
|  USBG-4FTDI*
| Working
| 11/2006
| 4
| FTDI FT232BL*
|  ?
| [http://www.mcmelectronics.com/product/83-10137 mcmelectronics.com]
| [http://forum.micasaverde.com/index.php?action=profile;u=4678 michaelk]
| 4 serial ports. Just plugged it in and it worked. There's also a 2-port model from the same place- that MIGHT work also. I assume it's FTDI becasue vera names the ports "ftdi_sio".  Fires right up from vera1's u sb port- but in case power is an issue it has a 5v input on the back so you can make it self powered. It's pretty generic- no name- etc. but feels solid- metal case and never had a problem with it over the years on a pc.   '''NOTE''':  *=I think it's the same as this page [http://www.usbgear.com/USBG-4FTDI.html usbgear.com] where I found that info
|}

=Ethernet-Serial Devices=
{| cellpadding="2" border="1" style="width: 1220px;"
|-
! Manufacturer
! Model #
! Status
! Date Purchased
! #RS-232 Ports
! Chipset
! Specs
! Purchased from
! Added by User
! Notes
|-
| WizNet
| WIZ110SR
| Working
| Jan 2010
| 1
| WIZnet
| [http://wiznet.co.kr/en/pro02.php?&page=1&num=20 Link]
| [http://www.sparkfun.com/commerce/product_info.php?products_id=9476 sparkfun.com]
| [http://forum.micasaverde.com/index.php?action=profile;u=2618 guessed]
| This is a stripped down Ethernet-enabled Serial/RS-232 Port. It's useful in situations where you might otherwise need a GC-100 to get "just a serial port" to connect to a TV, Amplifier etc. Don't forget to get yourself a 5V Power supply to drive it, or alternatively use a USB-5V Power code (as I do). Initial configuration of the device requires a Windows machine to run the configuration tool (DHCP, Baud Rate/Parity etc). Note that getting this "connected" to Vera is a manual process at this time. http://forum.micasaverde.com/index.php?topic=2989.0 . I use [http://www.sparkfun.com/commerce/product_info.php?products_id=8639 USB-5v] to power mine from an existing USB Power source (a USB Port on my DirecTV unit).
|-
|}

=Discussions=
*Forum Posting - [http://forum.micasaverde.com/index.php?topic=1471.0 How to make Vera recognize your USB-to-Serial Adapter]
*Forum Posting - [http://forum.micasaverde.com/index.php?topic=1170.0 Serial port:]
*Forum Posting - [http://forum.micasaverde.com/index.php?topic=1703.0 Attempts to get ser2net Proxy working on a remote router device]

Cooper Aspire Remote

2012-04-02T21:33:11Z

Micasaverde: Created page with "These instructions are for the Cooper Aspire Handheld remote. If you have previously been using the remote you should probably do a factory reset. Press 'Menu', choose 'Setting..."

These instructions are for the Cooper Aspire Handheld remote.

If you have previously been using the remote you should probably do a factory reset. Press 'Menu', choose 'Settings', choose 'Reset', and then press the Menu button again which is now marked 'Reset'.

First put Vera into include mode, such as pressing the '+' button, or choose Devices, Add Devices, add Z-Wave devices, option 1.

Next, to include the remote in Vera's network, press 'Menu', choose 'Settings', choose 'Replicate', choose 'Receive', choose 'From unknown controller'.

Note that it appears the Cooper remote uses it's own internal mechanism for creating scenes rather than the standard Z-Wave command classes, so you may not be able to create scenes within Vera which work on the Cooper remote.

Aeon HomeEnergyMonitor

2012-03-29T20:42:58Z

Micasaverde:

If you have version 3.58 or later of the HEM firmware (unrelated to Vera's firmware), it supports the ability to report in real-time whenever there is a change in the energy consumption.  It generates a report for Vera whenever there is a change.

For versions 3.57 and lower, the only way to get real time energy reporting was to have the HEM send Vera reports constantly, whether or not there was a change.  This required powering the HEM with USB power.  So we recommend using the USB port on the HEM to upgrade to firmware 3.58 or newer, as per the instructions on aeon-labs.com

There have been reported issues with HEM firmware less than 3.61. If you don't have 3.61, download this file (link to come)

[[Category:User_Instructions]] [[Category:Hardware]]

Luup Lua extensions

2012-03-27T04:29:37Z

Micasaverde: /* function: sunset / sunrise */

Luup Lua extensions

2012-03-27T04:03:12Z

Micasaverde: /* function: sleep */

Luup Requests

2012-03-21T22:41:24Z

Micasaverde:

[[Category:Development]]
In addition to sending requests using standard UPnP, you can also do most things using a simple HTTP requests. Use the built-in URL <tt>data_request</tt>, and pass the following on the URL:
*<tt>id</tt> the id of the request (prior to 15 Oct 2010 all requests had an lu_ in front, which is now optional),
*<tt>output_format</tt> the format in which you want a response as <tt>json</tt>, <tt>xml</tt> or <tt>text</tt>.

Not all requests support all <tt>output_format</tt> options. Here is a list of requests:

==user_data==

Example: http://ipaddress:3480/data_request?id=user_data&output_format=xml

This returns the configuration data for Vera, which is a list of all devices and the UPnP variables which are persisted between resets as well as rooms, names, and other data the user sets as part of the configuration.

==status==

Example: http://ipaddress:3480/data_request?id=status&output_format=xml

Or for a specific device: http://ipaddress:3480/data_request?id=status&output_format=xml&UDN=uuid:4d494342-5342-5645-0002-000000000002 or http://ipaddress:3480/data_request?id=status&output_format=xml&DeviceNum=6

This returns the current status for all devices including all the current upnp variables and the status of any active jobs.

==sdata==

This is an abbreviated form of user_data and status (sdata=summary data). It allows a user interface that is only worried about control, and not detailed configuration, to get a summary of the data that would normally be presented to the user and to monitor the changes. See [[UI_Simple]] for a walkthrough.

==actions==

==device==

Example: http://ipaddress:3480/data_request?id=device&action=rename&device=5&name=Chandalier&room=3

Example: http://ipaddress:3480/data_request?id=device&action=rename&device=5&name=Chandalier&room=Garage

Example: http://ipaddress:3480/data_request?id=device&action=delete&device=5

This renames or deletes a device. Use action=rename or action=delete. For rename, you can optionally assign a room by either passing either the ID or the name.

---old---
This returns all the XML with all the UPNP device description documents. Use: http://ipaddress:3480/data_request?id=device&output_format=xml&DeviceNum=x or &UDN=y to narrow it down. Then when you see the service URL's, like <SCPDURL>/luvd/S_HVAC_UserOperatingMode1.xml</SCPDURL>, you can view them with: http://ipaddress:3480/luvd/S_HVAC_UserOperatingMode1.xml
---end old---

==scene==

Example: http://ipaddress:3480/data_request?id=scene&action=record

Example: http://ipaddress:3480/data_request?id=scene&action=pause&seconds=y

Example: http://ipaddress:3480/data_request?id=scene&action=stoprecord

Example: http://ipaddress:3480/data_request?id=scene&action=listrecord

Example: http://ipaddress:3480/data_request?id=scene&action=deleterecord&number=x

Example: http://ipaddress:3480/data_request?id=scene&action=saverecord&name=whatever&room=X

Example: http://ipaddress:3480/data_request?id=scene&action=rename&scene=5&name=Chandalier&room=Garage

Example: http://ipaddress:3480/data_request?id=scene&action=delete&scene=5

Example: http://ipaddress:3480/data_request?id=scene&action=create&json=[valid json data]

Example: http://ipaddress:3480/data_request?id=scene&action=list&scene=5

This creates, renames, or deletes a scene depending on the action.

Recording a scene means whatever actions come in after sending the 'record' will be saved into an internal buffer. listrecord shows what's recorded so far. pause adds a pause. deleterecord deletes some action in the internal buffer. When deleting, for number=x, use the same 'id' in listrecord. saverecord takes the internal buffer, the recorded macro, and saves it as an actual scene.

To create a scene by hand, rather than recording it, use 'create'. When using the 'create' command json must be valid JSON for a scene as documented in [[Scene_Syntax]]. The name, room and optional id (if you're overwriting an existing scene) are passed in the json, so nothing is on the command line except the json. Because the json data can be long it is recommended to send it as an http POST instead of GET with the data passed with the name "json"

list returns the JSON data for an existing scene.

==room==

Example: http://ipaddress:3480/data_request?id=room&action=create&name=Kitchen

Example: http://ipaddress:3480/data_request?id=room&action=rename&room=5&name=Garage

Example: http://ipaddress:3480/data_request?id=scene&action=delete&room=5

This creates, renames, or deletes a room depending on the action. To rename or delete a room you must pass the room id for the room=.

==file==

==lua==

== action ==

Example: http://ipaddress:3480/data_request?id=action&output_format=xml&DeviceNum=6&serviceId=urn:upnp-org:serviceId:SwitchPower1&action=SetTarget&newTargetValue=1

Sends a UPnP action.

To run a scene, you send the action 'RunScene' like this::

http://ipadress:3480/data_request?id=lu_action&serviceId=urn:micasaverde-com:serviceId:HomeAutomationGateway1&action=RunScene&SceneNum=<SceneNum>

==variableset==

http://ip:3480/data_request?id=variableset&DeviceNum=6&serviceId=urn:micasaverde-com:serviceId:DoorLock1&Variable=Status&Value=1

If you leave off the DeviceNum and serviceID, then this sets a top-level json tag called "Variable" with the value.

==variableget==

http://ip:3480/data_request?id=variableget&DeviceNum=6&serviceId=urn:micasaverde-com:serviceId:DoorLock1&Variable=Status

If you leave off the DeviceNum and serviceID, then this gets a top-level json tag called "Variable".

==reload==

Resets the Luup engine with any new configuration settings.

==alive==

Return OK if the engine is running.

==finddevice==

Return the device id, UDN, device type of the first device that matches all the parameters passed on the URL: <tt>devtype</tt>, <tt>ip</tt>, <tt>id</tt>

==resync==

ReSync's all the devices, rooms, users, sections with event servers and returns OK

==wget==

Returns the contents of the URL you pass in the "url" argument. Optionally append "user" and "pass" arguments for http authentication, and "timeout" to specify the maximum time to wait in seconds.

==iprequests==

Returns the recent IP requests in order by most recent first, including information about devices in use and if the IP is blacklisted (ignored by the plug and play mechanism). Optionally append "oldest" to specify the oldest IP request in seconds.

==blacklistip==

Append "ip" to the URL, and optionally "remove=1" to add (or remove) the IP to the blacklist so plug and play IP devices won't be added.

Not implemented yet!

==live_energy_usage==

For backward compatibility it reports current energy usage in a tab delimited format

== request_image ==

'''NOTE:''' request_video is not implemented yet.


Returns an image from a camera. This fetches the image from the camera using the URL variable for the device. Pass arguments:

cam = the device id of the camera. This is the only mandatory argument.
res = optional: a resolution, which gets appended to the variable. So passing "low" means the image from the URL_low variable will be returned. If it doesn't exist it reverts to the standard URL or DirectStreamingURL
timeout = optional: how long to wait for the image to be retrieved, or how long to retrieve video. defaults to 10 seconds.
url = optional: override the camera's default URL
ip = optional: override the camera's default ip
user or pass = optional: override the camera's default username/password

==jobstatus==

==invoke==

==relay==

This tells the system to setup a relay so that you can access a device on the home network from outside the home. This is most commonly used to fetch streaming video from a camera, although it can actually be used for any IP device. This takes either an 'ip' or 'device' argument. If you pass a device, this is assumed to be a device ID, and the system will find the ip associated with that device. Optionally pass a port argument for the port you want to be relayed. Port 80 is assumed if none is specified.

This request will return a 'server:port' which you can use externally to access the designated device. The relay stays open for 15 minutes before closing, at which point you will need to open it again.

So, assume you have a NAS device on the home network with the ip 192.168.1.55 and the NAS runs a configuration web page on port 80. You could access it by doing this:

data_request?ip=192.168.1.55&port=80

and if the response is: "someserver:20202", then for 15 minutes, "http://someserver:20202" will be the NAS's configuration page.

If you want to access a camera, device #5, then do this:

data_request?device=5

and if the response is "someserver:20211" and if the 'DirectStreamURL' variable (or 'streaming' in sdata) is "video.mpeg", then for 15 minutes you can access the camera's video at: http://someserver:20211/video.mpeg

Note that if the device, the camera in this case, has http authentication, you will need to pass this too. So, if the user_data or sdata for the camera shows the user name is 'johndoe' and the password is 'john123', then you can view the video at: http://john:john123@someserver:20211/video.mpeg

IMPORTANT: For the 15 minutes while this relay is open, it will be open to anyone on the internet and public. Therefore, for security, you may want to add to the data_request the argument externalip=x where x is the routable, external IP, such as 70.182.172.111, of the device that will be accessing the port. This means that when the relay is open, a firewall will be set on the relay server so that incoming connections are only accepted from that ip address.

Camera Management Server

2012-03-19T23:31:57Z

Micasaverde: /* alert: Add an alert to the system */

[[Category:Services]]
Certain cameras come with custom firmware so that they automatically connect to the MiOS camera management server (cms), creating a tunnel the cms can use to send commands to the camera and to act as a relay so users can view and control the camera when outside the home without having to change their firewall.

Mios operates a camera server ("cs") which is available at crX.mios.com (ie cr1.mios.com, cr2.mios.com, etc.). Cameras which are shipped with this custom firmware will automatically connect to the cs and report their Mac Address and IP address. Cs stores this in a database along with the external IP that the connection came in on.

For most of the commands where you need to pass a username and password to the CMS server, you can also pass either a cam or a gateway and the corresponding hwkey if it's known.

==Locating the camera==

To get the list of all cameras and MiOS systems on your current home network, read this URL: http://sta1.mios.com/locator_json2.php which returns the list in JSON format. To add to the list all cameras that are off the home network but which can be access remotely with a given username, add a ?username=x to the URL, such as http://sta1.mios.com/locator_json2.php?username=johndoe

A camera will look like this:

{
"serialNumber": "554",
"Alive": 0,
"name": "Good camera",
"mfr": "Mios",
"ipAddress": "192.168.2.27",
"category": "2",
"subcategory": "1",
"users": "16782,3",
"ImageUrl_LR": "img/snapshot.cgi?size=320x240&quality=4",
"MJpegUrl_LR": "img/video.mjpeg",
"MP4Url_LR": "img/video.asf",
"ImageUrl_HR": "img/snapshot.cgi?size=640x480&quality=2",
"MJpegUrl_HR": "img/video.mjpeg",
"MP4Url_HR": "img/video.asf",
"CanRelay": "1",
"Port": "80",
"local_remote": "1",
"relay_remote": "1",
"active_server": "cr1.mios.com"
}

==Local vs remote access==

In the Json data above, "active_server" tells you which Cs the camera connects to. So to view or control this camera connect to cr1.mios.com. If the camera is on the same network as the client, then ipAddress will have an ip. Otherwise there is no ipAddress. If the ipAddress is specified, then you can access the camera on the local network, without going through the relay server, by using ImageUrl, MJpegUrl and MP4Url tags to fetch a JPEG Image, MJPEG stream, or MP4 stream. _LR are low res verseions, _HR are high res. If CanRelay is 1, then this camera connects to the cs and you can also view the camera remotely using the Cs.

==request_video: Request video from a camera==

To view the video from the camera, open this URL:

https://cr1.mios.com/request_video?cam=a&format=b&res=c&user=d&pass=e

where a is the serial number of the camera, 554 in the above example, b is one of the defined constants below, c is the resolution and can be l or m or h, d and e are the username/password of the MiOS account the camera is paired with.

This will return another URL. If the viewer is on the same home network as the camera the URL will point directly to the camera. Otherwise it will be a Url, for example http://209.160.41.93:80/relay_viewer?cam=554&pass=2024848122, which points to the Cs with a use-once token. In this case the URL can only be used one time, and must be used within 1 minute of making the request.

==request_image: Request image from a camera==

To fetch a JPEG that is the current image from the camera, open this URL:

https://cr1.mios.com/request_image?cam=a&res=b&user=c&pass=d

where a is the serial number of the camera, 554 in the above example, b is "low" or "med" or "high" to indicate the resolution, c and d are the username/password of the MiOS account the camera is paired with. Calling this with "low" is the right way to get at thumbnail. This URL returns the JPEG image directly.

==archive_video: Tells the cs to archive video from the camera ==

This command causes the cs to capture video from the camera and add it to the video archive for the user. The camera must be linked to a mios.com account.

https://cr1.mios.com/archive_video?cam=a&preroll=b&duration=c&format=d&res=e&user=f&pass=g

where a is the serial number of the camera, 554 in the above example, b is 0 or 1 where 1 means to also capture whatever pre-roll is available from the camera, c is how long in seconds to capture the video, d is one of the formats id's defined below, e is "low" or "med" or "high" to indicate the resolution, f and g are the username/password of the MiOS account the camera is paired with.

The pre-roll is a given number of seconds at a given resolution as specified in the "config" command.

==archive_image: Tells the cs to archive an image from the camera ==

This is like archive_video except it stores a single image. If retimg=1 then the image being archived will also be returned by the Url, just like request_image.

https://cr1.mios.com/archive_image?cam=a&res=b&user=c&pass=d&retimg=e

==list_alerts: The cs returns a list of archived alerts, both system alerts and images and video ==

https://cr1.mios.com/list_alerts?cam=a&gateway=b&unread=1&type=c&source=d&format=e&device=f&count=g&start=h&before=i&after=j&user=k&pass=l&userevt=m

This returns a list of archives in JSON format as follows:

{
"records": [
{
"id": 192817,
"gateway": "0",
"cam": "554",
"user": "",
"notification": "1827",
"device": "0",
"timestamp": "18217271",
"date": "",
"expiration": "18217271",
"read": "",
"type": "1",
"source": "0",
"format": "jpg",
"ip": "192.168.2.27",
"locked": "0",
"size": "32728",
"code": "",
"value": "",
"description": "Camera Image",
"key": "1278",
"comments": ""
}
]
}

The arguments are as follows:

cam=If specified this is the id of the camera(s). Only alerts from this camera(s) are included. Multiple cameras should be comma separated. Or specify * for all cameras the user has access to.

gateway=If specified this is of a gateway(s). Only alerts from this gateway(s) are included. Multiple cameras should be comma separated. Or specify * for all gateways the user has access to.

user=See note below.

NOTE: If neither cam nor gateway is specified, only alerts from the user which is passed for validation are included, such as login events. If a cam(s) and or gateways(s) are specified, then user alerts as well as gateway/cam alerts are included. If you only want gateway/cam alerts, add a user=0. This will exclude user events. So gateway=1,3&cam=* will include alerts from gateways #1 and 3, as well as all cameras, plus the users alerts. Adding user=0 will exclude the users alerts. If user=0 is specified without any gateway or cam no records are returned. Note that alerts from a gateway/cam will not be included if the gateway/cam is not already paired to the user's account.

unread=If this is a '1' only alerts that haven't been read yet are included

type=Only alerts of this type are included (see alert types below)

source=Only alerts from this source are included (see source types below)

format=Only alerts containing files of this format are included (eg mp4, jpg, mjpeg).

device=If a gateway is specified, only alerts from this device id on the gateway are included.

count=This many rows are included

start=Starting with this row number

before= / after= a date range as a unix timestamp (ie an integer in UTC time). You cannot use local time because some devices, like cameras, don't have a clock/timezone setting, so the times are universal timestamps applied by the server and not local times on the device.

The return data in json is as follows:

id=A numeric id of the alert

gateway=The id of the gateway that generated the alert, if any

cam=The id of the camera that generated the alert, if any

user=The id of the user that generated the alert, if any

notification=If user(s) were sent a notification of the alert (SMS, email) this is the id of the notification attempt(s)

device=If a device on a gateway generated the alert this is the device id

timestamp=The date when the alert was received as a unix timestamp

date=The date according to the gateway, specified in local time as yyyy-mm-dd hh:mm:ss

read=The date when the alert was read by the user as a unix timestamp

expiration=The date when the alert will be automatically deleted as a unix timestamp

type=The type of alert: 1=Image (a camera sent an image), 2=Video (a camera sent a video clip), 3=Trigger (a user-created trigger was fired), 4=Variable (a device changed state, such as a door was unlocked, a user code entered, a sensor tripped), 5=Login (a user logged into the portal), 6=Gateway Connected (a gateway came online)

source=What caused the alert to be generated: 1=User (e.g. user hit 'record' button or otherwise initiated the alert), 2=Timer (an automatic timer generated it), 3=Trigger (a user-created trigger), 4=Variable (some device changed state)

format=If there's a file associated with the alert, this is the extension, such as mpg, jpg, mjpeg

ip=The IP that sent the alert

locked=If 1 the alert will not automatically delete on the expiration

size=If there's a file associated with the alert, this is the size of the file

code and value=These depend on the type of alert. For Variables 'code' is the name of the variable (state) that changed and value is the new value.

description=A description for the alert. For triggers this is the user-defined trigger name.

key=A unique, random value for each alert. When you need to modify an alert you will pass back the key to confirm you are authorized.

comments=Comments which the user has associated with the alert.

If a file is associated with the alert, see the fetch_archive call.

==fetch_alert: Return the details about an alert==

https://cr1.mios.com/fetch_alert?id=a&key=b

Pass in the key from the alert (see list_alerts) as b and the alert id as a. This returns the details about the alert, including any notification attempts, as follows. Note the status codes for contacts and attempts are in the defined constants section:

{
"id": 192890,
"username": "aaronb",
"contacts": [
{
"id": 10,
"type": 1,
"destination": "john@gmail.com",
"numattempts": 0,
"status": "",
"contents": "200820:\r\n=\r\nserial:-\r\n",
"username": "john",
"attempts": [
{
"timestamp": 182821717,
"status": "1",
"notes": "busy"
},
{
"timestamp": 1812717,
"status": "2",
"notes": "complete"
}
]
},
{
"id": 20,
"type": 3,
"destination": "+1310-555-0800",
"numattempts": 0,
"status": "",
"contents": "200820:\r\n=\r\nserial:-\r\n",
"username": "john"
}
]
}

==alter_alert: Alert data in the alert==

https://cr1.mios.com/alter_alert?id=a&key=b&read=c&deleted=d&locked=e&comments=f

This will change the alert 'a'. Pass in the key from the alert (see list_alerts) as b. Optionally pass in a unix timestamp for c to indicate if it's read, or 0 to indicate it is unread. Pass in 0 or 1 for deleted or locked (d or e) to indicate if the record should be deleted, or if it's locked, meaning it won't be deleted after the expiration. Comments will update the user comments for an alert. Don't forget to properly URL encode the comments. read, deleted, locked and comments are all optional, although at least one must be specified.

==alert: Add an alert to the system==

https://cr1.mios.com/alert?PK_AccessPoint=a&PK_Accessory=b&EK_User=c&HW_Key=d&user=e&pass=f&DeviceID=g&LocalDate=h&AlertType=i&SourceType=j&Argument=k&Format=l&Code=m&Value=n&Description=o&Users=p&Expiration=q

Expiration should be a unix timestamp

==fetch_archive: The cs returns an archived image or video ==

https://cr1.mios.com/fetch_archive?id=a&user=b&pass=c

or

https://cr1.mios.com/fetch_archive?id=a&key=b

==move_camera: Tells the cs to move the camera ==

https://cr1.mios.com/move_camera?cam=a&dir=b&user=c&pass=d

Where dir can be "up", "down", "left", "right", "in" or "out" (for zoom).

==send: Sends a URL to the camera==

https://cr1.mios.com/send?cam=a&user=b&pass=c&url=d

Everything after the url= is sent to the camera.

For example:
https://cr1.mios.com/send?cam=37117&user=johndoe&pass=mypassword123&url=/adm/set_group.cgi?group=VIDEO&exposure=1&sharpness=7

Refer to the camera's manual for specific settings

==defined constants==

Here are the defined constants for format, resolution, etc., and the extensions that correspond to formats:

#define ALERT_IMAGE 1
#define ALERT_VIDEO 2
#define ALERT_TRIGGER 3
#define ALERT_VARIABLE 4
#define ALERT_LOGON 5
#define ALERT_GATEWAY_CONNECTED 6 // If the external IP changes or if it's been> 24 hours since last report

#define FORMAT_JPEG 1
#define FORMAT_MJPEG 2
#define FORMAT_MP4 3

#define EXT_JPEG "jpg"
#define EXT_MJPEG "mjpg"
#define EXT_MP4 "mp4"

#define SOURCE_USER 1
#define SOURCE_TIMER 2
#define SOURCE_TRIGGER 3
#define SOURCE_VARIABLE 4

#define CONTACT_STATUS_SUCCESS 0
#define CONTACT_STATUS_PROCESSING 1
#define CONTACT_STATUS_FAILED 2
#define CONTACT_STATUS_RETRY 3

#define ATTEMPT_STATUS_SUCCESS 0
#define ATTEMPT_STATUS_PROCESSING 1
#define ATTEMPT_STATUS_FAILED 2