BncsFramework.Init Method (String[], UInt32, UInt32, Boolean, String, String, String, String, String, String, String, Boolean, Boolean, Boolean, Boolean, Nullable<Assembly>, Nullable<String>[], String, Boolean, String, UInt32, Boolean)

<< Click to Display Table of Contents >>

Navigation:  Reference > BNCS.Core.DriverFramework Namespace > BncsFramework Class > BncsFramework Methods > Init Method  >

BncsFramework.Init Method (String[], UInt32, UInt32, Boolean, String, String, String, String, String, String, String, Boolean, Boolean, Boolean, Boolean, Nullable<Assembly>, Nullable<String>[], String, Boolean, String, UInt32, Boolean)

Initializes the BNCS framework with the specified configuration parameters.

Namespace: BNCS.Core.DriverFramework
Assembly:  BNCS.Core.DriverFramework (in BNCS.Core.DriverFramework.dll)

 

Syntax


public static void Init(
 string[] bindAddresses,
 uint bindPortHttp,
 uint bindPortHttps,
 bool enableSwagger,
 string mainInstance,
 string nodeId,
 string nodeDescription,
 string driverName,
 string manufacturerTag,
 string productTag,
 string instanceTag,
 bool enableBNCS,
 bool enableIS04,
 bool enableIS07,
 bool enableIS12,
 Nullable<Assembly> externalAssembly,
 Nullable<string>[] additionalViews,
 string customHomePage,
 bool useEmbeddedCSI,
 string wsAddress,
 uint wsPort,
 bool launchBrowser
)

Parameters

bindAddresses

Type: String[]
An array of IP addresses to bind the server to.

bindPortHttp

Type: UInt32
The port number for HTTP binding. Default is 5000.

bindPortHttps

Type: UInt32
The port number for HTTPS binding. Default is 5001.

enableSwagger

Type: Boolean
Indicates whether Swagger is enabled. Default is false.

mainInstance

Type: String
The main instance identifier for BNCS.

nodeId

Type: String
The node identifier.

nodeDescription

Type: String
The description of the node. Default is "BNCS Driver".

driverName

Type: String
The name of the driver. Default is "BNCS Driver".

manufacturerTag

Type: String
The manufacturer tag.

productTag

Type: String
The product tag.

instanceTag

Type: String
The instance tag.

enableBNCS

Type: Boolean
Indicates whether BNCS is enabled. Default is true.

enableIS04

Type: Boolean
Indicates whether NMOS IS-04 is enabled. Default is false.

enableIS07

Type: Boolean
Indicates whether NMOS IS-07 is enabled. Default is false.

enableIS12

Type: Boolean
Indicates whether NMOS IS-12 is enabled. Default is false.

externalAssembly

Type: Nullable<Assembly>
An optional external assembly for additional views and controllers.

additionalViews

Type: Nullable<String>[]
An array of additional views.

customHomePage

Type: String
The custom home page URL.

useEmbeddedCSI

Type: Boolean
Indicates whether to use embedded CSI. Default is false.

wsAddress

Type: String
The BNCS CSI WebSocket address. Default is "127.0.0.1".

wsPort

Type: UInt32
The BNCS CSI WebSocket port. Default is 44117.

launchBrowser

Type: Boolean
Launch driver UI in browser on startup.

 

Exceptions


Exception

Condition

BNCS.Core.DriverFramework.Classes.BncsVersionException

Thrown if embedded CSI is used with a BNCS version earlier than 6.0.

[ArgumentException]

Thrown if NMOS IS-04 is not enabled when IS-07 or IS-12 are used.

 

See Also


BncsFramework Class

Init Overload

BNCS.Core.DriverFramework Namespace