Rinnai N-BW2 Manual Download Page 8 | Manualshive

Page: 8 / 48

Rinnai N-BW2 Manual Download Page 8

N-BW2 Networker Bridge (WIFI)

API-N-BW2

Issue 1.3 Page 8 of 48

2.4 Opening a TCP Connection with the N-BW2

Before opening a TCP connection with the N-BW2 either the N-BW2 must:

-

Be associated with if it is operating in one of its Access Point states, or

-

Associate with the router it was configured to associate with when operating in its Station state.

Once this is the case the N-BW2 broadcasts a 256 byte long UDP packet every second using the following
broadcast settings:

-

Broadcast address : ###.###.###.255

-

Broadcast port : 50000

Embedded within this UDP broadcast packet is information listed in the example shown in FIG 2.4a.

FIG 2.4a: N-BW2 UDP Broadcast Packet

From this UDP packet the IP address of the N-BW2 (source address) can be determined and together with the
information listed above all the information needed to open a TCP connection with the N-BW2 is available. Once
a valid TCP connection with the N-BW2 is opened the N-BW2 responds with “

*HELLO*

”. Provided the client

issues commands to the N-BW2 the TCP connection will remain open. If no response from the client that initiates
the connection is received within the TCP timeout time (

T

TCPOUT

), the N-BW2 will terminate the connection and

perform a reboot.

Index

Description

0000h – 001Fh

N-BW2 identification tag.

0020h – 0021h

TCP port, high byte first.

In this case 6Ch C7h equates to port 27847.

0022h

Default AP operating state indication.

AAh

Operating in Default AP state.

55h

Not operating in Default AP state.

0023h

Overal firmware version of module.

0024h

Wi-Fi Module firmware version.

0025h

WLAN access mode.

0

AP Mode – Default.

1

AP Mode – User Configured.

2

Station Mode – Uer Configured.

00FFh

Number of scanned SSIDs (Default AP mode only).

FOR SCANNED SSIDs n = 0 to 9

0100h + n x 23h

SSID name.

0100h + n x 20h

SSID name length.

0100h + n x 21h

Security type

OPEN – 0

WEP – 1

WPA – 2

WPA2 – 3

0100h + n x 22h

Received Signal Strength Indication (RSSI)

N-BW2 IP Address

«
...
6
7
8
9
10
...
»

Summary of Contents for N-BW2

Page 1: ...N BW2 Networker Bridge WIFI API N BW2 Issue 1 3 Page 1 of 48 N BW2 Networker Bridge WIFI Application Programmers Interface Issue 1 3 ...

Page 2: ...ated Group 1 SYST ______________________________________________ 16 4 3 Heating Related Group 1 HGOM ____________________________________________ 18 4 3 1 Single Set Point Operation _____________________________________________________________ 19 4 3 2 Multi Set Point Operation______________________________________________________________ 21 4 4 Cooling Add on Related Group 1 CGOM ________________...

Page 3: ...ry Issue Date Change Details Change by Approved by 1 0 04 04 18 First release Emilio Emilio 1 1 19 06 18 Added zone temperature measurement descriptor to ZXS tags for STSP operation MT Emilio Emilio 1 2 19 03 19 Configuration settings packet delimiter changed from to carriage return 0x0D Extra version number information added to SYST CFG Temperature display option added to ECOM CFG Extra informati...

Page 4: ... first powered on When in this state only the WIFI configuration mode is allowed 2 User configured Access Point AP state In this state the N BW2 operates as an access point which can be associated with The SSID and WPA pass phrase are defined by the user When operating in this state a network router is not needed to access the Networker system By default the N BW2 will operate in the Networker sys...

Page 5: ...3 Page 5 of 48 2 2 Networker System Connection 2 2 1 N C3 N C6 Type Networkers The N BW2 must be powered by its own 12VDC plug pack and connected to the system as illustrated in FIG 2 2 1a FIG 2 2 1a N BW2 Connection to N C3 N C6 Networker Controls ...

Page 6: ...onding connector on the N BW2 In this case the 12VDC plug pack is not needed to power the N BW2 See FIG 2 2 2a FIG 2 2 2a N BW2 Connection to Brivis Touch System Using Interface Module Port When no spare port is available on the Brivis Touch Interface Module then the N BW2 must be powered by its own 12VDC plug pack and connected to the system as illustrated in FIG 2 2 2b FIG 2 2 2b N BW2 Connectio...

Page 7: ...oint state is reverted to 1 When the N BW2 is switched on for the very first time 2 When the N BW2 has not had user configuration settings saved to its internal memory 3 On power up when the AP button has been held pressed for at least 5 seconds 4 When the N BW2 has been configured to operate in the Station state but the router it was configured to associate with could not be located after 3 minut...

Page 8: ... BW2 is available Once a valid TCP connection with the N BW2 is opened the N BW2 responds with HELLO Provided the client issues commands to the N BW2 the TCP connection will remain open If no response from the client that initiates the connection is received within the TCP timeout time TTCPOUT the N BW2 will terminate the connection and perform a reboot Index Description 0000h 001Fh N BW2 identifi...

Page 9: ...orker Bridge WIFI API N BW2 Issue 1 3 Page 9 of 48 The entire process for connecting to the N BW2 is illustrated in FLC 2 4a The TCP packet size to allow for is 2080 bytes minimum FLC 2 4a Connecting to the N BW2 ...

Page 10: ...settings to memory WIFI module is configuring itself for Default AP state operation due to AP pushbutton being pressed Flash Slow Continuous WIFI module is in the Default AP state with no client associated with it Flash Once WIFI module is in the Default AP state and a packet transfer has occurred Flash N Times Repeatedly WIFI module has experienced a fault the number of flashes indicates the faul...

Page 11: ...access End of tag descriptor TAG VALUE The associated tag value where applicable CR Carriage Return 0x0D End of command TABLE 3a WIFI Configuration Mode Command Format The tag descriptors that are supported are listed in TABLE 3b TAG Descriptor Access Description Default SSID G S R Allows the user configured SSID to be set or retrieved NPWD S The user configured SSID WPA pass phrase to be set Must...

Page 12: ...st accompany any GET command to gain access to the setting as is illustrated in the following example On issuing CG SSID CR Response packet produced CG DVPW CR In this example the N BW2 responded in this way because the default password issued with the GET command was invalid On issuing CG DVPW 1234567890 SSID CR Response packet produced CG DVPW SSID MyNetworkCR In this example the N BW2 responded...

Page 13: ...n Settings The N BW2 settings that are altered are not committed to its onboard memory This must be explicitly done with the SAVE tag accompanied by the default password as illustrated below On issuing CS DVPW 1234567890 SAVE CR Response packet produced CG DVPW SAVE CR Upon saving the configuration settings to its onboard memory the N BW2 undergoes a reboot therefore when altering the settings the...

Page 14: ...orresponding value CD2 VAL Group 2 associated command and corresponding value CD VAL Group 2 associated command and corresponding last value End of Group 2 Commands End of Group 2 Text End of Group 1 Text TABLE 4a Networker System Access Mode Command Format Commands are grouped based on functionality The Group 1 descriptor is at the top of the hierarchy with the following supported 1 SYST System r...

Page 15: ...e number is used to indicate when a command has been received by the N BW2 Before the client application issues a command it should get the current value of the sequence number increment it if 255 wrap around to 0 then use this incremented value in the command packet The N BW2 on receiving this command packet will use this sequence number in the next status packet it issues the client application ...

Page 16: ...imum ZC R Alphanumeric Zone C description 16 characters maximum ZD R Alphanumeric Zone D description 16 characters maximum VR R 0000 9999 N BW2 firmware version CV R 000 999 N BW2 WiFi module firmware version CC R 000 255 Certificate checksum value NC R Y N N C7 based system Y Yes N No AVM HG R Y N Gas heating Y Yes N No EC R Y N Cooling Evaporative Y Yes N No CG R Y N Cooling Add on Y Yes N No RA...

Page 17: ...R Y N Fault has been detected Y Yes N No GP R H E C R N Appliance type exhibiting fault H Heating E Cooling Evap C Cooling Add on R Reverse Cycle N Controlling Device UT R 01 15 Identification of unit exhibiting fault TP R M B L Fault Severity M Minor B Busy L Lockout CD R Fault Code TABLE 4 2a Networker System SYST Group ...

Page 18: ...stem is zoned and each zone that exists in the system can have its own operating characteristics For example one zone can be under manual control while another is under schedule control both with different set point temperatures defined The SYST CFG MTSP tag indicates the current operating mode the system is in The commands required for these two distinct modes differ slightly so they are describe...

Page 19: ... Only CF W Y N Circulation fan on Y Yes N No FL W 01 16 Fan only operation speed level 01 16 GSO General System Operation OP W A M Schedule or Manual A Schedule M Manual SP 00 30 Set point temperature 8 OFF AO W N A O Schedule override N None A Advance O Operation GSS General System Status HC R Y N Calling for heat Y Yes N No FS R Y N Fan active Y Yes N No GV R Y N Gas valve active Y Yes N No PH R...

Page 20: ...g for heat Y Yes N No ZDS Zone D Status MT R 000 999 Measured temperature x10 999 indicates undefined AE R Y N Auto enabled Calling for heat Y Yes N No APS System Schedule Setup AV W Y N Active Y Yes N No DY W MON SUN Day of the week to program Individual day grouping MON TUE WED THU FRI SAT SUN WD W Y N Program weekdays Weekday day grouping Y Yes N No TP W W L R P S Time period being programmed W...

Page 21: ...ation ST W F N Z Operating State F Off N On Z Fan Only CF W Y N Circulation fan on Y Yes N No FL W 01 16 Fan only operation speed level 01 16 ZXO Zone X Operation X A B C D UE W Y N User enabled Fan Only Y Yes N No OP W A M Schedule or Manual A Schedule M Manual SP 00 30 Set point temperature 8 OFF AO W N A O Schedule override N None A Advance O Operation ZXS Zone X Status X A B C D AE R Y N Auto ...

Page 22: ...or use Y Yes N No DY W MON SUN Day of the week to program Individual day grouping MON TUE WED THU FRI SAT SUN WD W Y N Program weekdays Weekday day grouping Y Yes N No TP W W L R P S Time period being programmed W L R P S Wake Leave Return Pre Sleep Sleep TM hh mm W 00 23 00 59 Time period start time in 24 hour format SP W 00 30 Time period set point temperature 8 OFF TABLE 4 3 2a Networker System...

Page 23: ...ing system is zoned and each zone that exists in the system can have its own operating characteristics For example one zone can be under manual control while another is under schedule control both with different set point temperatures defined The SYST CFG MTSP tag indicates the current operating mode the system is in The commands required for these two distinct modes differ slightly so they are de...

Page 24: ... F Off N On Z Fan Only CF W Y N Circulation fan on Y Yes N No FL W 01 16 Fan only operation speed level 01 16 GSO General System Operation OP W A M Schedule or Manual A Schedule M Manual SP 00 30 Set point temperature 8 OFF AO W N A O Schedule override N None A Advance O Operation GSS General System Status CC R Y N Calling for cool Y Yes N No FS R Y N Fan active Y Yes N No CP R Y N Compressor acti...

Page 25: ...g for cool Y Yes N No ZDS Zone D Status MT R 000 999 Measured temperature x10 999 indicates undefined AE R Y N Auto enabled Calling for cool Y Yes N No APS System Schedule Setup AV W Y N Active Y Yes N No DY W MON SUN Day of the week to program Individual day grouping MON TUE WED THU FRI SAT SUN WD W Y N Program weekdays Weekday day grouping Y Yes N No TP W W L R P S Time period being programmed W...

Page 26: ...s OOP Overall Operation ST W F N Z Operating State F Off N On Z Fan Only CF W Y N Circulation fan on Y Yes N No FL W 01 16 Fan only operation speed level 01 16 ZXO Zone X Operation X A B C D UE W Y N User enabled Fan Only Y Yes N No OP W A M Schedule or Manual A Schedule M Manual SP 00 30 Set point temperature 8 OFF AO W N A O Schedule override N None A Advance O Operation ZXS Zone X Status X A B ...

Page 27: ...or use Y Yes N No DY W MON SUN Day of the week to program Individual day grouping MON TUE WED THU FRI SAT SUN WD W Y N Program weekdays Weekday day grouping Y Yes N No TP W W L R P S Time period being programmed W L R P S Wake Leave Return Pre Sleep Sleep TM hh mm W 00 23 00 59 Time period start time in 24 hour format SP W 00 30 Time period set point temperature 8 OFF TABLE 4 4 2a Networker System...

Page 28: ...tate F Off N On OP W M A Operating state M Manual A Auto FS W F N Fan state Manual operation F Off N On PS W F N Pump state Manual operation F Off N On FL W 01 16 Fan speed level 01 16 Manual Operation SP W 19 34 Comfort level Set Point 19 34 Auto Operation ZUUE W Y N Zone U user enabled Y Yes N No ZAUE W Y N Zone A user enabled Y Yes N No ZBUE W Y N Zone B user enabled Y Yes N No ZCUE W Y N Zone ...

Page 29: ...N Switched on pump state F Off N On FL W 01 16 Switched on fan speed level 01 16 Manual Operation SP W 19 34 Switched on comfort level Set Point 19 34 Auto Operation SFT hh mm W 00 23 00 59 Time to switch off SFE W Y N Switch off enabled Y Yes N No ZUUE W Y N Zone U user enabled at switch on Y Yes N No ZAUE W Y N Zone A user enabled at switch on Y Yes N No ZBUE W Y N Zone B user enabled at switch ...

Page 30: ... connection to the N BW2 must be established by selecting the CONNECT via WIFI label as illustrated in FIG 5a FIG 5a N BW2 Interface Test Application Connecting to N BW2 Once a connection is established the application will show the current Networker System status unless the N BW2 is operating in its Default AP state In this latter case the WIFI configuration screen will be automatically displayed...

Page 31: ...ngs can be retrieved provided the corresponding N BW2 default password has been entered correctly as illustrated in FIG 5 1b The corresponding GET label flashed green indicates successful retrieval of the setting The WPA pass phrase password cannot be retrieved only set FIG 5 1b N BW2 Interface Test Application GET Settings Default password of N BW2 to gain access to configuration settings Command...

Page 32: ...ssword has been entered correctly as illustrated in FIG 5 1c The corresponding SET label flashed green indicates successful writing of the setting FIG 5 1c N BW2 Interface Test Application SET Settings WIFI configuration setting SET command issued Altered settings not committed to memory until the SAVE SETTINGS label is selected WIFI configuration setting SET command response ...

Page 33: ... long to fit in the receive label provided The required information to display can be defined by clicking on the receive data label and selecting the GROUP 1 2 tags accordingly as illustrated in FIG 5 2b FIG 5 2b N BW2 Interface Test Application Group Tag Selection A greyed label indicates this function is not available in this example the evaporative cooling operating mode is not available Receiv...

Page 34: ...N BW2 Networker Bridge WIFI API N BW2 Issue 1 3 Page 34 of 48 FIG 5 2c N BW2 Interface Test Application Group Tag Selection Now only HGOM ZAO groups are processed ...

Page 35: ...zones installed the heating operating mode screen appears as illustrated in FIG 5 3 1 1a below FIG 5 3 1 1a Heating Operating Mode Switched off Single Set Point Operation No Zones When the heating operating mode is switched on the screen appears as illustrated in FIG 5 3 1 1b with various command functions illustrated Continued Command to switch heating on ...

Page 36: ... BW2 Networker Bridge WIFI API N BW2 Issue 1 3 Page 36 of 48 Continued Command to change set point temperature to 25 C Command to change to schedule operation Command to advance the schedule time period ...

Page 37: ...N BW2 Networker Bridge WIFI API N BW2 Issue 1 3 Page 37 of 48 FIG 5 3 1 1b Heating Operating Mode Switched on Single Set Point Operation No Zones Command to cancel the schedule override ...

Page 38: ...h Zone B selected resulting in the temperature measured in this zone being displayed FIG 5 3 1 2a Heating Operating Mode Switched off Single Set Point Operation 2 Zones Installed When the heating operating mode is switched on the screen appears as illustrated in FIG 5 3 1 2b FIG 5 3 1 2b Heating Operating Mode Switched on Single Set Point Operation 2 Zones Installed Command to user disable Zone A ...

Page 39: ...Heating Operating Mode Schedule Setting Access Single Set Point Operation 2 Zones Installed When the heating schedule setting mode is being accessed the screen appears as illustrated in FIG 5 3 1 3b with various command functions illustrated Continued Command to access the schedule setting mode Zones A B selected as user enabled for this time period Wake time period selected for Mon Fri group Comm...

Page 40: ...5 3 1 3b Heating Operating Mode Schedule Setting Functions Single Set Point Operation 2 Zones Installed Command to set the Return time period time to 17 30 Command to switch off Zome A for the Return time period Command to set the Return set point temperature to 22 C ...

Page 41: ...switched off FIG 5 3 2a Heating Operating Mode Switched off Multi Set Point Operation 4 Zones Installed When the heating operating mode is switched on the screen appears as illustrated in FIG 5 3 2b with various command functions illustrated Continued Selected zone description can now be used Individual status of zones can now be displayed Each zone can be controlled individually User enabling dis...

Page 42: ...rker Bridge WIFI API N BW2 Issue 1 3 Page 42 of 48 Continued Command to change Zone B set point temperature to 25 C Command to change Zone B to schedule operation Command to advance the Zone B schedule time period ...

Page 43: ...ion 4 Zones The screen appears as illustrated in FIG 5 3 2c when the heating operating mode is switched to fan only operation FIG 5 3 2c Heating Operating Mode Switched to Fan Only Multi Set Point Operation 4 Zones Command to cancel the Zone B schedule override Under fan only operation user enable disable control of zones allowed ...

Page 44: ...es the currently selected zone into the schedule setting mode as illustrated in FIG 5 3 2d below FIG 5 3 2d Heating Operating Mode Schedule Setting Multi Set Point Operation 4 Zones Command to access schedule settings of Zone D Command to access the Return time period schedule settings of Zone D ...

Page 45: ...BW2 Networker Bridge WIFI API N BW2 Issue 1 3 Page 45 of 48 5 4 Cooling Add on Operating Mode This operating mode is identical to the Heating operating mode except that the CGOM tag precedes the commands ...

Page 46: ...ve Cooling Operating Mode Switched off The evaporative cooling operating mode screen appears as illustrated in FIG 5 5b below when the evaporative cooling is switched on under manual control with the pump switched off FIG 5 5b Evaporative Cooling Operating Mode Switched on Manual Control Select to enter the program to switch on mode Command to switch pump off under manual control Cooling busy indi...

Page 47: ...48 The evaporative cooling operating mode screen appears as illustrated in FIG 5 5c below when the evaporative cooling is switched on under auto control FIG 5 5c Evaporative Cooling Operating Mode Switched on Auto Control Command to switch over to auto control ...

Page 48: ...8 5 6 Switching Operating Mode The example below shows switching from the evaporative cooling operating mode to the heating operating mode in this case while the system was switched on FIG 5 6a Switching Operating Mode Command to switch operating mode to Heating ...

Reviews:

No comments