Rinnai N-BW2 Manual
Hide thumbs Also See for N-BW2:

Advertisement

Quick Links

N-BW2 Networker Bridge (WIFI)
Application Programmers Interface
Issue 1.3
N-BW2 Networker Bridge (WIFI)
API-N-BW2
Issue 1.3
Page 1 of 48

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the N-BW2 and is the answer not in the manual?

Questions and answers

Summary of Contents for Rinnai N-BW2

  • Page 1 N-BW2 Networker Bridge (WIFI) Application Programmers Interface Issue 1.3 N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 1 of 48...
  • Page 2: Table Of Contents

    2.2.1 N-C3 & N-C6 Type Networkers __________________________________________________________ 5 2.2.2 Brivis Touch (N-C7) Type Networker _____________________________________________________ 6 2.3 Default Access Point State _________________________________________________________ 7 2.4 Opening a TCP Connection with the N-BW2 _________________________________________ 8 2.5 Front Panel LEDs ______________________________________________________________ 10 WIFI Configuration Mode ___________________________________________________ 11 3.1 Retrieving Configuration Settings _________________________________________________ 12...
  • Page 3: Document Information

    Temperature display option added to: { “ECOM”: { “CFG”: Extra information added to UDP broadcast packet. Emilio Emilio 13/11/19 Added temperature measurement descriptor to GSS tag for ECOM operation ( “MT”: “###” N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 3 of 48...
  • Page 4: N-Bw2 Networker Bridge (Wifi) Operation

    Rinnai Networker based systems allowing control and monitoring of heating/cooling appliances the Networker system manages. The primary interface used for access to the Networker system is a TCP connection over WIFI. Although a USB port is provided this is purely for production testing and setup when the N-BW2 is produced.
  • Page 5: Networker System Connection

    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 N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3...
  • Page 6: Brivis Touch (N-C7) Type Networker

    2.2.2 Brivis Touch (N-C7) Type Networker When a spare port is available on the Brivis Touch Interface Module this port can be used to connect the N-BW2 as it is pin-to-pin compatible with the corresponding connector on the N-BW2. In this case the 12VDC plug-pack is not needed to power the N-BW2 –...
  • Page 7: Default Access Point State

    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 minutes. The N-BW2 will revert to its Default AP state for 2 minutes before reverting back to the user configured Station state.
  • Page 8: Opening A Tcp Connection With The N-Bw2

    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...
  • Page 9 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 N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 9 of 48...
  • Page 10: Front Panel Leds

    WIFI module is waiting for switch over to the Station state after being in the Default AP state with no connection by a client for 2 minutes. TABLE 2.5a: N-BW2 Front Panel LEDs N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3...
  • Page 11: Wifi Configuration Mode

    The TCP timeout time (T 5 minutes TCPOUT Range = 1 to 60 minutes. <SAVE> Initiate save settings upon which the N-BW2 reboots with the new configuration settings applied <BOOT> Reboot N-BW2 without saving any configurations settings applied. TABLE 3b: WIFI Configuration Command Tag...
  • Page 12: Retrieving Configuration Settings

    In any other state this mode will be entered when a configuration type command is issued by the client. Once in the WIFI Configuration Mode the N-BW2 defaults to reporting the two most basic settings, as illustrated below: CR<SSID><JOIN>CR...
  • Page 13: Saving Configuration Settings

    The SSID associated WPA pass-phrase must be at least 8 characters long. When setting this password the validity of the password is checked by the N-BW2 and if invalid the N-BW2 will respond accordingly as illustrated in the following examples: CS<DVPW>1234567890<NPWD>InvalidPasswordCR...
  • Page 14: Networker System Access Mode

    Evaporative Cooling Operating Mode related commands. Each group 1 tag descriptor has a defined set of group 2 related tag descriptors these described in the corresponding Group 1 descriptor sections. N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 14 of 48...
  • Page 15: Sequence Numbering

    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 using this to determine when the command packet has been received by the N-BW2.
  • Page 16: System Related - Group 1: {"Syst

    4.2 System Related – Group 1: {“SYST”: This group identifies system wide information and is always sent by the N-BW2 as part of the status information reported. In TABLE 4.2a below the “R” in the COMMAND column indicates read-only operation while a “W”...
  • Page 17 Identification of unit exhibiting fault “TP”: “$” M,B,L Fault Severity M = Minor B = Busy L = Lockout “CD”: “##” Fault Code TABLE 4.2a: Networker System {“SYST”: Group N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 17 of 48...
  • Page 18: Heating Related - Group 1: {"Hgom

    4.3 Heating Related – Group 1: {“HGOM”: This group identifies heating related information and is sent by the N-BW2 as part of the status information reported when heating is the current operating mode of the Networker System. Under the heating operating mode, there exists two very distinct modes of operation:...
  • Page 19: Single Set Point Operation

    Zone C Operation “UE”: “$” (Y/N) User enabled Y = Yes N = No {“ZDO”: { Zone D Operation “UE”: “$” (Y/N) User enabled Y = Yes N = No Continued… N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 19 of 48...
  • Page 20 Zone C programmed state F = OFF N = ON “ZD”: “$” Zone D programmed state F = OFF N = ON TABLE 4.3.1a: Networker System {“HGOM”: Group Single Set Point Operation N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 20 of 48...
  • Page 21: Multi-Set Point Operation

    Measured temperature (x10). (999 indicates undefined) Schedule operating mode time period “AT”: “$” W,L,R,P,S Wake Leave Return Pre-Sleep Sleep Schedule time period advanced to “AZ”: “$” W,L,R,P,S Wake Leave Return Pre-Sleep Sleep Continued… N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 21 of 48...
  • Page 22 Time period start time in 24 hour format “hh:mm” “SP”: “##” 00 – 30 Time period set point temperature (< 8 = OFF) TABLE 4.3.2a: Networker System {“HGOM”: Group Multi-Set Point Operation N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 22 of 48...
  • Page 23: Cooling (Add-On) Related - Group 1: {"Cgom

    4.4 Cooling (Add-on) Related – Group 1: {“CGOM”: This group identifies add-on cooling related information and is sent by the N-BW2 as part of the status information reported when cooling is the current operating mode of the Networker System. Under the cooling operating mode, there exists two very distinct modes of operation:...
  • Page 24: Single Set Point Operation

    Zone C Operation “UE”: “$” (Y/N) User enabled Y = Yes N = No {“ZDO”: { Zone D Operation “UE”: “$” (Y/N) User enabled Y = Yes N = No Continued… N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 24 of 48...
  • Page 25 Zone C programmed state F = OFF N = ON “ZD”: “$” Zone D programmed state F = OFF N = ON TABLE 4.4.1a: Networker System {“CGOM”: Group Single Set Point Operation N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 25 of 48...
  • Page 26: Multi-Set Point Operation

    Measured temperature (x10). (999 indicates undefined) Schedule operating mode time period “AT”: “$” W,L,R,P,S Wake Leave Return Pre-Sleep Sleep Schedule time period advanced to “AZ”: “$” W,L,R,P,S Wake Leave Return Pre-Sleep Sleep Continued… N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 26 of 48...
  • Page 27 Time period start time in 24 hour format “hh:mm” “SP”: “##” 00 – 30 Time period set point temperature (< 8 = OFF) TABLE 4.4.2a: Networker System {“CGOM”: Group Multi-Set Point Operation N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 27 of 48...
  • Page 28: Cooling (Evaporative) Related - Group 1: {"Ecom

    4.5 Cooling (Evaporative) Related – Group 1: {“ECOM”: This group identifies evaporative cooling related information and is sent by the N-BW2 as part of the status information reported when evaporative cooling is the current operating mode of the Networker System. In TABLE 4.5a below the “R”...
  • Page 29 Zone C user enabled at switch Y = Yes N = No “ZDUE”: “$” Zone D user enabled at switch Y = Yes N = No TABLE 4.5a: Networker System {“ECOM”: Group N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 29 of 48...
  • Page 30: N-Bw2 Interface Test Application

    BW2 is operating in its Default AP state. In this latter case the WIFI configuration screen will be automatically displayed as the N-BW2 is by default in the WIFI Configuration mode when it is operating in the Default AP state.
  • Page 31: Wifi Configuration Screen

    5.1 WIFI Configuration Screen The WIFI Configuration mode of the N-BW2 can be forced by selecting the WIFI CONFIGURATION label, the appearance of this screen illustrated in FIG 5.1a. Default password of N-BW2 to gain access to configuration settings. Command issued/response text.
  • Page 32 Using the SET labels the various configuration settings can be written provided the corresponding N-BW2 default password has been entered correctly as illustrated in FIG 5.1c. The corresponding SET label flashed green indicates successful writing of the setting. Altered settings not...
  • Page 33: Networker System Access Screen

    Transmit command sequence number. FIG 5.2a: N-BW2 Interface Test Application – Networker System Access The Networker System status can be a lengthy packet, too 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.
  • Page 34 Now only {“HGOM”: {“ZAO”: groups are processed. FIG 5.2c: N-BW2 Interface Test Application – Group Tag Selection N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 34 of 48...
  • Page 35: Heating Operating Mode

    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. Command to switch heating Continued… N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 35 of 48...
  • Page 36 Command to change set point temperature to 25°C. Command to change to schedule operation. Command to advance the schedule time period. Continued… N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 36 of 48...
  • Page 37 Command to cancel the schedule override. FIG 5.3.1.1b: Heating Operating Mode (Switched on) – Single Set Point Operation (No Zones) N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 37 of 48...
  • Page 38: Two Zones Installed

    When the heating operating mode is switched on the screen appears as illustrated in FIG 5.3.1.2b. Command to user disable Zone A. FIG 5.3.1.2b: Heating Operating Mode (Switched on) – Single Set Point Operation (2 Zones Installed) N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 38 of 48...
  • Page 39: Schedule Setting (Auto-Program)

    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. Command to access the “Return” time period. Continued… N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 39 of 48...
  • Page 40 Zome A for the “Return” time period. Command to set the “Return” set point temperature to 22°C. FIG 5.3.1.3b: Heating Operating Mode (Schedule Setting Functions) – Single Set Point Operation (2 Zones Installed) N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 40 of 48...
  • Page 41: Multi Set Point Operation

    When the heating operating mode is switched on the screen appears as illustrated in FIG 5.3.2b with various command functions illustrated. Each zone can be controlled individually User enabling/disabling of the zone is not available. Command to switch heating Continued… N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 41 of 48...
  • Page 42 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. Continued… N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 42 of 48...
  • Page 43 The screen appears as illustrated in FIG 5.3.2c when the heating operating mode is switched to fan only operation. Under fan only operation user enable/disable control of zones allowed. FIG 5.3.2c: Heating Operating Mode (Switched to Fan Only) – Multi Set Point Operation (4 Zones) N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 43 of 48...
  • Page 44 Zone D. Command to access the “Return” time period schedule settings of Zone D. FIG 5.3.2d: Heating Operating Mode (Schedule Setting) – Multi Set Point Operation (4 Zones) N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 44 of 48...
  • Page 45: Cooling (Add-On) Operating Mode

    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. N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 45 of 48...
  • Page 46: Cooling (Evaporative) Operating Mode

    Cooling busy indication. Select to enter the “program to switch off” mode. Command to switch pump off under manual control. FIG 5.5b: Evaporative Cooling Operating Mode (Switched on – Manual Control) N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 46 of 48...
  • Page 47 The evaporative cooling operating mode screen appears as illustrated in FIG 5.5c below when the evaporative cooling is switched on under auto control. Command to switch over to auto control. FIG 5.5c: Evaporative Cooling Operating Mode (Switched on – Auto Control) N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 47 of 48...
  • Page 48: 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”. Command to switch operating mode to Heating. FIG 5.6a: Switching Operating Mode N-BW2 Networker Bridge (WIFI) API-N-BW2 Issue 1.3 Page 48 of 48...

Table of Contents