Rainforest Automation RAVEn Xml Api Manual Download Page 1 | Manualshive

Page: 1 / 29

background image

www.rainforestautomation.com

RAVEn

™

Radio Adaptor for Viewing Energy

XML API Manual

Version 1.27

March 2013

1
2
3
...
»

Summary of Contents for RAVEn

Page 1: ...www rainforestautomation com RAVEn Radio Adaptor for Viewing Energy XML API Manual Version 1 27 March 2013...

Page 2: ...pies can be sold given or loaned to another person Under the law copying includes translating into another language or format Rainforest Automation may have patents patent applications trademarks copy...

Page 3: ...ON_STATUS 10 5 Notify ConnectionStatus 10 6 Command GET_DEVICE_INFO 11 7 Notify DeviceInfo 11 8 Command GET_SCHEDULE 11 9 Notify ScheduleInfo 12 10 Command SET_SCHEDULE 12 11 Command SET_SCHEDULE_DEFA...

Page 4: ...22 1 Command GET_INSTANTANEOUS_DEMAND 23 2 Notify InstantaneousDemand 23 3 Command GET_CURRENT_SUMMATION_DELIVERED 24 4 Notify CurrentSummationDelivered 24 5 Command GET_CURRENT_PERIOD_USAGE 25 6 Noti...

Page 5: ...e in the future in order to support UTF 8 Settings for the virtual serial COM port PORT NAME determined by OS BAUD RATE 115 200 DATA BITS 8 PARITY N STOP BITS 1 The RAVEn uses an asynchronous serial c...

Page 6: ...ions that contain information about the event For example 1 Send a GET_CURRENT_PRICE command which causes the RAVEn to request the current price stored in the meter 2 RAVEn returns a PriceCluster noti...

Page 7: ...e Command is the start tag for the command XML Fragment Name is the start tag for the name of the command indicates the variable number of command specific parameters RAVEN sends notifications with th...

Page 8: ...rouping of notifications and commands The API is organized into these Features Feature Description RAVEn RAVEn device specific information Meter Meter specific information Time Time and Date informati...

Page 9: ...ZE command to have the RAVEn reinitialize the XML parser Use this command when first connecting to the RAVEn prior to sending any other commands While initialization is not required it will speed up t...

Page 10: ...ddr LinkStrength 0xFF LinkStrength ConnectionStatus Element Range Description DeviceMacId 0xFFFFFFFFFFFFFFFF Unique MAC Address of the RAVEn MeterMacId 0xFFFFFFFFFFFFFFFF Unique MAC Address of meter S...

Page 11: ...lId DateCode string DateCode DeviceInfo Element Range Description DeviceMacId 0xFFFFFFFFFFFFFFFF Unique MAC Address of the RAVEn InstallCode 0xFFFFFFFFFFFFFFFF Install Code LinkKey 0xFFFFFFFFFFFFFFFFF...

Page 12: ...f meter Event time price demand summation message The type of event being scheduled Frequency 0x0 0xFFFFFFFE The frequency in seconds the event will be executed Enabled Y N Y the scheduled event will...

Page 13: ...one meter Unique MAC Address of meter Event time price demand summation message The type of event being scheduled if omitted command applies to all scheduled items 12 Command GET_METER_LIST Send the...

Page 14: ...ange Description MeterMacId 0xFFFFFFFFFFFFFFFF Optional if only one meter Unique MAC Address of meter 2 Notify MeterInfo MeterInfo notifications provide information about meters that are on the networ...

Page 15: ...nnel 00 Channel ShortAddr 0xFFFF ShortAddr LinkStrength 0xFF LinkStrength NetworkInfo Element Range Description DeviceMacId 0xFFFFFFFFFFFFFFFF Unique MAC Address of the RAVEn CoordMacId 0xFFFFFFFFFFFF...

Page 16: ...rMacId NickName string NickName Account string Account Auth string Auth host string host enabled enumeration enabled Command Element Range Description MeterMacId 0xFFFFFFFFFFFFFFFF Optional if only on...

Page 17: ...FFFFFFFFFFF Optional if only one meter Unique MAC Address of meter Refresh Y N Optional Y Get current time from meter N Get time from RAVEn cache default 2 Notify TimeCluster TimeCluster notifications...

Page 18: ...erMacId 0xFFFFFFFFFFFFFFFF Optional if only one meter Unique MAC Address of meter Refresh Y N Optional Y Get current message from meter N Get message from RAVEn cache default 2 Notify MessageCluster M...

Page 19: ...fault Confirmed Y N Y the user confirmation has been sent N the user confirmation has not been sent default Queue Active Cancel Pending Active Indicates message is in active queue Cancel Pending Indic...

Page 20: ...rMacId Refresh enumeration Refresh Command Element Range Description MeterMacId 0xFFFFFFFFFFFFFFFF Optional if only one meter Unique MAC Address of meter Refresh Y N Optional If user price is set this...

Page 21: ...rt meter PriceCluster DeviceMacId 0xFFFFFFFFFFFFFFFF DeviceMacId MeterMacId 0xFFFFFFFFFFFFFFFF MeterMacId TimeStamp 0xFFFFFFFF TimeStamp Price 0x00000000 Price Currency 0x0000 Currency TrailingDigits...

Page 22: ...to return almost real time data readings from the smart meter usually for when the User wants to see the effect of turning something on or off Reading Calculations readings are recorded as integers an...

Page 23: ...rded by the meter InstantaneousDemand DeviceMacId 0xFFFFFFFFFFFFFFFF DeviceMacId MeterMacId 0xFFFFFFFFFFFFFFFF MeterMacId TimeStamp 0xFFFFFFFF TimeStamp Demand 0x000000 Demand Multiplier 0x00000000 Mu...

Page 24: ...tal consumption to date as recorded by the meter CurrentSummationDelivered DeviceMacId 0xFFFFFFFFFFFFFFFF DeviceMacId MeterMacId 0xFFFFFFFFFFFFFFFF MeterMacId TimeStamp 0xFFFFFFFF TimeStamp SummationD...

Page 25: ...e meter Unique MAC Address of meter 6 Notify CurrentPeriodUsage CurrentPeriodUsage notification provides the total consumption for the current accumulation period as calculated by the RAVEn The Multip...

Page 26: ...digits to the right of the decimal point to display DigitsLeft 0x00 0xFF Number of digits to the left of the decimal point to display Suppress LeadingZero Y N Y Do not display leading zeros N Display...

Page 27: ...acId 0xFFFFFFFFFFFFFFFF Unique MAC Address of meter LastUsage 0x0 0xFFFFFFFF The previous period total consumption value Multiplier 0x0 0xFFFFFFFF The multiplier ignore if zero Divisor 0x0 0xFFFFFFFF...

Page 28: ...equency to poll meter in seconds Duration 0x0 0x0384 Duration of fast poll mode in seconds maximum is 15 minutes 11 Command GET_PROFILE_DATA Send the GET_PROFILE_DATA command to get the RAVEn to retri...

Page 29: ...NumberOfPeriodsDelivered 0x00 NumberOfPeriodsDelivered IntervalData 0x000000 IntervalData ProfileData Element Range Description DeviceMacId 0xFFFFFFFFFFFFFFFF Unique MAC Address of the RAVEn MeterMac...

Reviews:

No comments

Related manuals for RAVEn

Brand: Panasonic Pages: 8

Brand: 1320 Electronics LLC Pages: 5

Brand: YOKOGAWA Pages: 2

Brand: Allied Telesis Pages: 2

68VHDCI-50F SSR 8

Brand: National Instruments Pages: 4

Brand: HIKOKI Pages: 100

Thunderbolt MTB3-002-HD

Brand: Tripp Lite Pages: 31

EZ Connect N SMCWUSBS-N

Brand: SMC Networks Pages: 64

Brand: Aironet Pages: 99

Brand: l-com Pages: 34

Brand: Digitus Pages: 7

Brand: ZyXEL Communications Pages: 67

Brand: Atheros Pages: 39

Brand: D-Link Pages: 23

Brand: Alpine Pages: 44

Brand: Snom Pages: 2

Brand: Plantronics Pages: 1

Plug Prong Adapter

Brand: Plantronics Pages: 2

Brands by name

0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Popular brands

Load more brands