‍What is an Integration Broker (IB)?

A smart software application to allow different systems to communicate with one another simultaneously without having to write code.
‍
A code and cloud free software solution that runs on a host processor of you choice.
‍
It's scalable, configurable, multi-function, hardware agnostic, zero-code commissioning, is cloud free and has a mobile visualized active dashboard for commissioning and troubleshooting.
‍
It's designed for an integrator to easily connect systems that don't normally connect to one another.
‍‍

How does an IB differ from a Gateway ?

Protocol gateways, also known as protocol translators, are often small non-descript devices that mainly function as translators for various protocols and physical layers, and are often quite specific to the system/brands they are translating. Sometimes this means the translation can be very specific too, and not always generic enough for an IB to use.

An Integration Broker on the other hand is a software application that passes messages between more than one system using defined protocols. Sometimes gateways are required (dependant on what is being integrated) to translate one protocol to another for the IB to work.
‍
In the IB, multiple services can be activated to achieve multiple, simultaneous communication paths to different systems. The Integration Broker is scalable, configurable, multi-function and can run on different host processors and operating systems.
‍
‍For example you might have a wireless lighting system that you want to work with an existing wired lighting control system, and have them communicating with each other, and with a central control system as well. The Integration Broker (IB) is designed to do such integrations.
‍
With the appropriate services and licences, you can configure the IB, map the necessary data points, control functions etc to make connections to a number of different systems. You still have to setup, configure and program the other systems as usual, but that's all. The IB takes care of all protocol translations, the complex inter-messaging timings, data packet formats, headers, bit depths and the list goes on, leaving you to get on with the job of integrating the systems.
‍
So an IB is really nothing like a gateway!
‍
In fact S4i has a dedicated Casambi USB gateway specifically for the IB. The gateway is designed to connect to the IB Host via USB and connect to a wireless Casambi networks directly without having to resort to protocol conversion and the limitation and costs that these impose.

The Gateway is Casambi enabled by virtue of having a Casambi CBM-003 chip within, allowing it to be paired directly to any wireless Casambi mesh network. Once connected and paired to a Casambi network, all nodes can be mapped to other supported systems, and the IB XAPI API, XBAC BACNET and MQTT for third party control system integration.

What equipment is required to run the IB?

The IB can run on a number of different "Host" processors.
‍
The type and number of Hosts used is determined by the size and complexity of the system/s being integrating with.
‍
S4i doesn't sell Hosts, that's up to you to purchase. We just recommend processors and operating systems that we have tested and know work.

Please refer to the IB Datasheets in th e Resouces section for further information or contact us if you require help in choosing.
‍

Which Host do I use to run an IB?

There are 2 criteria that determine which Host processor to use;
1/ total number of Integration Services/Licences required - ie the number of different systems being integrated with
2/ total number of "Endpoint" channels and Control Point channels to be integrated

Once determined, you can quickly work out which of the Host types is suitable to use - Domestic/Starter - Commercial or Enterprise.

Note: The use of the term Starter/Domestic in this instance denotes a capacity and processing limit only - it is not meant to necessarily mean it is for domestic use only.
Eg Any small business that requires less than the max capacity of 6 Integration services, and less than 256 channel of lighting can use a "Domestic " licensed IB running on one of the recommended hosts.

You may prefer to use a particular OS, in which case you can use any of the recommended Hosts for your project, as long as the Host limits (Integration Services with licences and/or channels) are not exceeded. For instance you might prefer to use the Mac mini M1 in a project rather than the Raspberry Pi4, even though you wont necessarily be using all the capabilities of the Commercial IB Licence the Mac Mini offers. It's up to you entirely.

Please note there are some specific operating system versions that are required to be used. These need to be adhered as other versions may not be reliable. For example the recommended Windows operating system is Win 10 IoT Enterprise. Other versions of Window have either not been tested or have been and prove to be unreliable. Please refer to the IB Datasheets Recomendations section for further information or contact us if you require help in choosing.

Note; Each IB in a project requires its own set of licences. Activated licences are tied to that particular Host. Licences cannot be shared between Hosts or re-assigned elsewhere.
‍

Is there an API available for 3rd Party Integration?

Yes the S4i XAPI API, XBAC BACnet and MQTT options are available.

XAPI & XBAC, MQTT are licenced integration services that requires either a licenced Commercial or Enterprise IB host to operate.
‍
As with all Integration licences, a these licence apply only to the IB Host it resides on. Licences cannot be share across Hosts.
‍
‍XAPI,BACNET and MQTT provides integration with full 2 way control and feedback with any Casambi enabled luminaire from any BMS, control system or IoT platform using TCP or Websockets.
‍With these you can now create a complete master control UI/dashboard, web application or integrate to an existing control application to control Casambi lights.

In conjunction with the recently released S4i Casambi USB Gateway, the following Casambi functions are now available via these services;
    Channel Level Fade
    Channel Level Status - in real time
    Casambi Group Level Fade
    Casambi Group Level Status
    Casambi Scene Level Fade
    RGBW - Full Colour Control
    TW - Tunable White Control
    TW - TC Status
‍
Channel Status for the following; (dependent on the fitting profile supporting the conditions)
    Online/oﬄine
    Lamp_failure
    Etc

What are Integration Services and Licences?

Licensed Integration Services enable different types of integration capabilities to be activated in the IB.
‍
There are 2 service with licence types required;
          1/ IB Application with licence to enable IB to run on a specific Host
            Every Host requires its own IB Licence
           Once the IB Licence is activated it is tied to the Host and is NOT transferable
‍
         2/ Integration Service Licence/s to enable different systems to connect to one another through the IB eg. lighting systems, control systems, security, (coming soon), etc.

Every IB requires it's own Integration Licences to the systems it will connect to. As with all Integration licences, a licence applies only to the IB Host it resides on. Licences cannot be share across Hosts.
‍
Integration licences may be available with different capacity options, and or functional capabilities.
In Lighting for instance, channel capacity options are offered.
The correct channel capacity to use is based on the TOTAL number of channels both systems utilise to communicate with one another- that is Inputs & Outputs. Eg Casambi to Dynalite - 128 channels integrated to Dynalite requires a 256 Channel Licence for all channels to communicate across the IB.
‍
Note: For each instance of Color control (using RGBW) 8 channels are used and each instance of Tuneable White (TW) requires 3 channels.
Keep this in mind when working out the total number of channels required lighting licence.

         2/ Integration services and licences to enable different systems to connect to one another eg - Lighting service, XAPI service, BACNET and MQTT services etc

Note: Licences cannot be shared between Hosts - Licences only apply to the Host they reside on.

The great thing is additional services can be added any time in the future, when additional integration services or expansions are required.
‍

‍

Do I have to renew licences?

Yes & No, as that depends on whether you have a Subscription licence or a Perpetual licence.

All S4i Service Licences are available as either a Subscription or Perpetual licence basis.

A Perpetual licence allows the service to run forever on a particular major version. However adding additional Integration services in the future may require the current licences to be upgraded to suit newer hardware, and or software enhancements that the new integration services support.
        Licence Upgrades can be purchased as required.
‍
A Subscription licences run for a minimum of 12 months and offers the following benefits;
        It is the best way to keep all the IB services up-to-date with improvements, additional capabilities or changes in protocols etc that may occur over time.
        It ensures updates are readily available, during the subscription period.
        It offers the lowest initial acquisition cost to access S4i IB services and solutions.
        It offers better affordability with a predictable payment schedule, becoming a part of operational expenditure.

Note when a subscription licence expires, the service will no long operate.
‍
As a subscription licence approaches its expiry, the IB system will attempt, via the internet, to connect to our cloud licence manager for a renewed subscription. It will continue this until the expiry date is past at which time the service with stop running.

A reminder email will be sent prior to subscription expiry. This will be sent to the email address entered at the time of licence purchase.
‍

What do I need to make all this work?

1/ At least one Host processor to run the S4i IB (refer data sheets for recommended Hosts)

2/ 1 x IB Application with Licence for the Host (licence type is based on Host type in use - this is NOT transferable)
‍
3/ Integration service licences for each system to be connected and integrated with on that Host
‍
4/ In addition you will need the necessary Gateways, Interfaces etc for each of the systems being integrated. These are system dependent - please refer to datasheets in the Resources section for more information.

Please also refer to Integration datasheets for recommendations on suitable hardware.
‍

Where do I purchase IB App and Service licences?

Please contact S4i direct for all purchase enquiries at sales@s4i.io.
‍

What happen after I make a purchase?

When an IB Licence is purchased emails are sent with the following;
       1/ a receipt for your purchase with a link to pdf receipt and invoice
       2/ a link to download; S4i Integration Broker Software to be installed on your Host plus installation guides, user manuals and commissioning guides
       2/ a Licence Key to activate the IB - please keep these records as they are required for activating the IB

When Integration Service Licences are purchased emails are sent with the following;
        1/ a receipt for your purchase with a link to pdf receipt and invoice
       2/ Licence Key/s to activate the Integration Services in the Integration Broker application - please keep these records as they are required for activating the Integration Services
‍
All licences & keys are managed in the S4i Web Admin Portal which runs following installation of the IB Software package downloaded at time of purchase.

Access to the Web Admin Portal login is via your favourite browser.

Do I need to program anything?

There is no programming required in the Broker.
‍
You are only required to configure the Broker.
‍
You need to configure communication elements using either the "auto-mapping" feature available in the Commercial or Enterprise IB, or use the Master Configuration Spreadsheet (MCS) from within the Web Admin Portal to map the channels manually.

Note: When the IB is installed and running there is an "default example.xls spreadsheet available to download in the Files Section of the Web Admin Portal. This can be used as a template for mapping your project channels.

Information such as system gateway addresses, IP details, Dali channels, control area names, channel names, area names and the mapping of endpoint channels to user Control channels are all required to let the IB know how and what it must communicate with.

Configuration & setup manuals you receive when you purchase the IB solution clearly show the processes required to setup & configure an S4i IB

‍NOTE: Of course you must setup, configure and program the other systems being used, as usual.
As an integrator you must have full working knowledge of the systems you are integrating as it is entirely your responsibility to get it all working.

Only suitably qualified technicians should undertake these works.
‍

Where do I get assistance if I have problems?

Assistance can be sort via either the Contact section of this web site or by sending an email to support@s4i.io
Please note our support staff provides assistance relating to the S4i Broker operations only.

We have extensive knowledge in the integration of systems and will be as helpful as possible, however we do not provide general support relating to the systems being integrated with, issues relating to the general setup of Host processors or issues relating to networks connecting the Host to all the integrated systems.‍‍

Why are "Naming Conventions" important for Solutions for Integrators IB and integration?

Solutions for Integrators IB (Integration Broker) is a powerful middleware platform that enables communication and integration between different applications and systems. When it comes to naming conventions for IB, there are a few best practices that can help ensure consistency and clarity across your integration projects.

First and foremost, it's important to choose descriptive and meaningful names for your integrations, services, and other objects within IB. This can help ensure that everyone involved in the project understands the purpose and function of each component, which can save time and reduce confusion down the line.

In addition, it's a good idea to follow a consistent naming convention for different types of objects within IB. This can help make it easier to identify the type of object at a glance, and can also help with sorting and organizing objects within the IB console.

When it comes to naming individual elements within your integrations, such as lighting channels, scenes and sensor channels etc, it's helpful to use descriptive names that reflect the purpose of the element. This can help make it clear what the element is, and can also make it easier to troubleshoot and debug your integrations if issues arise. More importantly it allows the IB to utilize the "auto-mapping" feature for fast automated mapping (connections) between the different systems being integrated.

Overall, following consistent and meaningful naming conventions can help ensure that your integration projects are organized, easy to understand, fast and and easy to maintain over time. By taking the time to establish clear naming conventions upfront, you can set yourself and your team up for success with Solutions for Integrators IB.

Assistance can be sort via either the Contact section of this web site or by sending an email to support@s4i.io‍‍

Casambi Integration to Dynalite/CBus/KNX

Casambi DIRECT integration to Dynalite/CBus/KNX?

Casambi lighting can be integrated directly with an IB using S4i's own Casambi USB.

‍This uses our own Casambi USB, to connect an IB directly to a Casambi Bluetooth network. Providing up to 250 Node connections ready for mapping to Dynalite, CBus, KNX or directly using the XAPI (API), BACnet and MQTT intergation options.
‍
A suitable IB Host (based on Project size etc) and a licensed IB application is required.
Lighting Integration Licence/s with the appropriate channel capacity also required.

For further more details on the new S4i Casambi USB gateway please refer to Gateway Function Matrix page or contact sales@s4i.io direct.
‍

‍How do I integrate Dynalite/CBus to Casambi using DALI?

When reading below please refer to our ... Resources ... downloads page for reference Datasheets with diagrams
‍
1/ Use Casambi DCS DALI Gateways (1 for every 64 channels) to convert Casambi to DALI, plus one of the recommended DALI Ethernet Gateways (1 for every 64 channels) to convert DALI channels to a protocol the IB can work with

2a/ For the Dynalite system integration, a Dynalite Ethernet Gateway (PDEG) is required to connect the IB to the Dynalite network, plus a Dynalite DTK622-USB PC Node for programming the Dynalite system - (note the PDEG is used exclusively for S4i IB comms - it cannot be used to program the Dynalite system)

2b/ For Cbus system integration the same point 1/ applies plus a Cbus CNI is required to connect to the IB to the Cbus network

3/ A suitable IB Host (Commercial or Domestic) with a licensed IB application
‍
4/ Lighting Integration Service Licence with the appropriate channel capacity. Supporting from 128 to 2560 lighting channels available (IB Host dependent)
‍
Communication between the systems is locally handled by the IB. You do not require a permanent Internet connection for the system to operate. However an internet connection IS required to initial manage licence activation, updates and any licence renewals, if subscription licences are used.
‍

Is Color and Tunable White control possible?

Yes it is.
‍
S4i IB supports DALI DT8 (RGBW/TW) control when using a Gateway that can support it (e.g. S4i Casambi USB Gateway, Control Freak DALI EDIDIO S10 or Beckhoff DALI PLC).

R, G, B, W and TC are available for mapping to separate logical channels (virtual addresses) in other lighting systems such as Dynalite, CBUS etc.

Hue/Sat/Value (HSV or HSB) are also available from S4i IB for more human-friendly color control user interface.

Note:
         Each instance of RGBW requires up to 8 channels allocated and TW requires 3 channels.
        These additional channels must be allowed for in the total channel count in order to select the correct sized licence to use.

Why do we have to purchase only the Gateways recommended?

NOT ALL GATEWAYS ARE THE SAME !
It is important to understand gateways all work differently and have different capabilities and functionality. More often than not these are very specific to the system & brand they are converting. Which means the protocol is very specific too and not always generic enough to be suitable for the IB.

Gateways differ greatly! Few can pass all of the necessary information to the IB, in the format required to achieve a workable integration solution we are looking for. That is why we have so few recommendations.

Please refer to our Gateway Function Matrix to compare control function capabilities and to be sure to select a gateway that matches your requirements.

Note we are constantly testing Gateways for compatibility and we'll update our recommendations with those that match our requirements.

Please note if you decide to use non-recommended gateways, you are on own !
‍

Setting up Casambi, Dynalite, Cbus, Dali and Gateways?

It is the integrator's responsibility to design, setup, configure, program and fully commission all systems.

The integrator must have full working knowledge of the systems being integrated with, as setting up configuring and programming of them is their responsibility. In this instance a comprehensive knowledge of commissioning Casambi, DALI, Dynalite, or CBus is required.

Only suitably qualified personnel should undertake these works.

Note there are some specific IB set-up and configuration requirements that are applicable to different integrated systems. Please refer to S4I IB Commission Guides - Casambi/Dynalite/DALI or Casambi/Cbus/DALI for further details. These document are supplied as part of the purchase package.
‍
Please also note S4i does NOT provide support for any 3rd party systems being integrated with the S4i IB.
‍

What happens if I want to make changes to either of the systems?

Systems can be changed at any time.

It is important to understand the the IB needs to know what changes have been made in order for the integration to continue to work seamlessly.
‍
So for instance, if a channel is added, deleted or renamed then the "mapping" table within the IB must be updated accordingly so the IB knows where to send or received the messages assigned to that channel. Any changes are done from within the Web Admin Portal that runs on the IB.
‍
That is all that has to be done.