Skip to main content
Back to Hanwha Vision Tech Support Portal

How do I set up an IP speaker and controller in WAVE to play audio on an analytic event?

  • Updated

Applies to: WAVE 

Summary

This article describes the steps needed to play required audio files on Hanwha IP Speakers on camera events by setting up rules in WAVE with an appropriate SUNAPI http command. Two devices are needed to achieve this: a controller, such as SPA-D1000 Audio Module, to route the SUNAPI command, and a speaker, such as SPA-H100, to play audio.

Setting up the SPA-H100 Speaker

To set up the speaker:

  1. Login to the speaker with username and password. 

  2. If the speaker firmware version is less than 3.4.4.12, download the latest version and upgrade using the following steps. 

    NOTE: The latest firmware can be found at the product page on Hanwha Vision America.

    If an upgrade is not needed, go to Time Setting. 
  3. Select Environment Setting > System Management.

    1.png

  4. On the System Upgrade page, select the downloaded upgrade file, then click Apply. 

    2.png

  5. After the upgrade completes, under Factory Default Setting, click Apply next to Network Status to factory default the unit.

    3.png

Time Setting

  1.  Select Environment Setting > Time Setting. 

    4.png

  2. Set the correct time zone and date/time.

  3. Click Apply.

Network Setting

  1. Select Environment Setting > Network Setting. 

    6.png

  2. Setup the IP Address and Subnet Mask, then click Apply.

Device Operation Setting

  1. Select Environment Setting > Device Operation Setting. 

    1.png

  2. Set Operation Mode to Speaker, then click Apply.

  3. Set Power Mode to PoE+.
    NOTE: Set to PoE only if PoE+ power is not available.
  4. Click Apply.

TTS File Management

  1. Select Operation Setting > TTS File Management.



  2. Add TTS files by entering text.

  3. Select language and gender. 
  4. Select Start Chime and End Chime.
  5. Click Save.

Source File Management

  1. Select Operation Setting > Source File Management.
  2. Click Browse to add audio files (mp3, wav, tts), then click Upload. 

    Uploaded audio files appear in Source File List in right hand side.

  3. To check audio files, click Number under Source File List.  

Setting up the SPA-D1000 Controller

To set up the SPA-D1000 controller: 

  1. Login to the controller with username and password.

  2. Select Environment Setting > System Management.
  3. Under System Upgrade, setup the latest version of the firmware using the instructions in Setting up the SPA-H100 Speaker. 
  4. Select Environment Setting > System Management. 
  5. Under Factory Default Setting, click Apply by Network Status Maintain.

Time Setting

  1. Select Environment Setting > Time Setting.
  2. Set the correct time zone and date/time.

  3. Click Apply.

Network Setting

  1. Select Environment Setting > Network Setting. 

  2. Setup the IP Address and Subnet Mask, then click Apply.

Device Operation Setting

  1. Select Environment Setting > Device Operation Setting. 

  2. Set Operation Mode to Controller, then click Apply.

Device Registration

  1. Select System Setting > Device Registration. 

  2. Move the speaker under Device Search to the right hand side.

    The speaker appears under Registered Device.

    1.png

  3. Click Apply.

Register the Speaker Audio Files in the Controller

MP3/WAV Files

  1. Select System Setting > Source Registration.
  2. Enter the ID in the ID field.

  3. In IP Address, select the speaker IP.

  4. Enter the model name in the Model Name field.

  5. Enter H100 in Device Name. 

  6. Enter “ “ in the Location field.

  7. Enter 3000 in the Priority field.

  8. Enter Horn in the Source Name field.

  9. Enter BGM for the Source Type.

  10. Enter 1-BGM in the CTRL&Name field.

  11. Select AOE-Multicast in the Transmission drop-down menu.

  12. : Select 224.124.0.2 in the TransIP drop-down menu.

  13. Select 5454 for the Port.

  14. Select the checkbox under CTRL.

  15. Select Speaker-IP in the CTRL IP drop-down menu.

  16. Select file_player in the CTRL type drop-down menu.

  17. Click Apply. 

TTS Files

To register the speaker:

  1. Follow steps 1-8 in MP3/WAV Files.
  2. Enter TTS for the Source Type.

  3. Enter 2-TTS in the CTRL&Name field.

  4. Select AOE-Multicast in the Transmission drop-down menu.

  5. Select 224.124.0.2 in the TransIP drop-down menu.

  6. Select 5454 for the Port.

  7. Select the checkbox under CTRL.

  8. Select Speaker-IP in the CTRL IP drop-down menu.

  9. Enter SPA-H100 in the Device Name field. 

  10. Select tts_player in the CTRL type drop-down menu.

  11. Enter 2 in the I/O CH field.

  12. Click Apply. 

  13. Select System Setting > Zone Registration. 



  14. Enter the Zone Name.

  15. Enter Speaker IP in the IP Address field. 

  16. Enter audio_output_1 in the Channel field.

  17. Select System Setting > Group Setting to create speaker groups with zones if needed. (Group ID or Speaker ID can be used in SUNAPI command).

    1.png

    NOTE: Audio/TTS files will not play in the SUNAPI command if Zone and Group are not 
    setup.

Confirming Controller Settings

To confirm the controller settings:

  1. Select Operate > Button Mode > Source > Zone.

    Source and Zone appear under Property.

  2. Click Stop Broadcasting, then Start Broadcasting.

  3. Under Source Control, select the audio file from the drop-down and click Play.

    Music plays in the speaker.

Discovering Speakers and IDs

The speakers and IDs on the server are needed to play audio on a speaker. 

NOTE: admin credentials are required to run SUNAPI command.
  1. Open a browser and enter the command.

    http://IP-of-Controller/stw-cgi/system.cgi?msubmenu=registeredsubdevices&action=view
    for example, http://192.168.2.90/stw-cgi/system.cgi?msubmenu=registeredsubdevices&action=view

  2. Note the ID of the speaker from the browser.

    Sample output of http command in browser.

{
"IP": "192.168.2.90",
"ID": 3,
"NAME": "SPA-D1000",
"TYPE": "SPEAKER"
},
{
"IP": "192.168.2.91",
"ID": 2,
"NAME": "SPA-H100",
"TYPE": "SPEAKER"
}

Discovering Speaker Groups and IDs

To discover speaker groups:

NOTE: Group ID is needed in http command to play audio.
  1. Open a browser and enter the command with Controller IP.

    http://IP-of-Controller/stw-cgi/system.cgi?msubmenu=speakergroups&action=view
    for example, http://192.168.2.90/stw-cgi/system.cgi?msubmenu=speakergroups&action=view

  2. If the Speaker Group with associated Zone is not created, the command will not work.

  3. Note the Group IDs from the browser response.
    "Group": [
    {
    "ID": "1",
    "Name": "Group1",
    "DeviceIDs": "1,2"
    },

Discovering Audio Files Accessible by Controller

To discover audio files:

  1. Open a browser and enter the command with ControllerIP.

    http://IP-of-Controller/stw-cgi/eventrules.cgi?msubmenu=audiooutfiles&action=view
    for example, http://192.168.2.90/stw-cgi/eventrules.cgi?msubmenu=audiooutfiles&action=view

  2. Note the audio file names (needed in http command to play back in speakers).

    "AudioOutFiles": {
    "FreeSpace": "1024",
    "TotalSpace": "1024",
    "AudioClips": [
    { "Name": "Src1_Song1.mp3" },
    { "Name": "Src1_Song2.mp3"

Discovering TTS Files Accessible by Controller

To discover TTS files: 

  1. Open a browser and enter the command with the Controller IP.

    http://IP-of-Controller/stw-cgi/eventrules.cgi?msubmenu=ttsfiles&action=view
    for example, http://192.168.2.90/stw-cgi/eventrules.cgi?msubmenu=ttsfiles&action=view

  2. Note the TTS file names in the response. The response appears as:

    "TTSFiles": {
    "TTSList":
    [{ "Name": "Src1_TestTTS” } ]}
NOTE: tts file name does not have an extension.

Testing the Commands to Play Audio from a Specific Speaker

  1. Open a browser, enter the command using ControllerIP and SpeakerID. Sample commands are shown below.

    http://192.168.2.90/stw-cgi/eventrules.cgi?msubmenu=audiooutfiles&action=control&Type=Play&Name=Src1_Song1.mp3&SpeakerID=2

    http://192.168.2.90/stw-cgi/eventrules.cgi?msubmenu=ttsfiles&action=control&Type=Play&Name=Src1_TestTTS&SpeakerID=2

    The audio plays in the speaker.

Testing the Commands to Play Audio from a Group of Speakers

  1. Open a browser and enter the command using ControllerIP and SpeakerGroupId. Sample command is shown below.

    http://192.168.2.90/stw-cgi/eventrules.cgi?msubmenu=audiooutfiles&action=control&Type=Play&Name=Src1_Song2.mp3&GroupID=1

  2. Once audio is confirmed, the above http SUNAPI commands can be used to setup an event rule in WAVE. These can be played from a single speaker or group of speakers.

Resolutions to Errors

  1. When a command is executed, the browser indicates Response = Success and the speaker plays the requested audio.

  2. If there are http Errors:
    Response=Fail
    code=608
    Error = Feature not implemented or not supported
    Check whether the Speaker IP is
    used. It should use the Controller IP.

  3. If the Response = fail or code=609, not authorized, check whether there is space or other characters in the URL.

  4. If the sign in box keeps coming back, check whether an invalid password was entered. 

Setting up WAVE Rules to Play Audio on IP Speaker

To set up WAVE rules:

  1. Open WAVE. 

  2. Click Ctrl + E to open the Event Rules. 

    image (1).png

  3. Click +Add.



  4. Under Event, select Analytics Event from the When drop-down menu. 

  5. Select the required camera from the At drop-down menu. 

  6. Select the setup analytics such as Intrusion from the Event Type drop-down menu. 

  7. Under Action, select DoHTTP(S) request from the Do drop-down menu. 

  8. Select the checkbox by Interval of Action.

  9. Increase the default as needed.

  10. In HTTP(s) URL, enter the tested command to play TTS or audio files on a specific speaker or group of speakers.

  11. Enter the speaker credentials in Login field.

  12. Click Apply. 

    Once Rule is setup in WAVE, audio plays in the IP Speaker when an analytic event is triggered in the camera.


Related articles