NuboCamWizard (v2.1)

Hints:
  • iOS specific: NuboCamWizard's callback onPreparedForConnection returns nothing.
  • iOS specific: NuboCamWizard's method connectToCamera takes no parameters. User should connect to Wifi via Settings app, then return to app and call this method.
  • iOS specific: For iOS12 and higher you should add Access Wifi Information capability (Target Name - Capabilities) in order to use NuboCamWizard otherwise iOS would not grant SDK access to Wifi information.
  • Android specific: NuboCamWizard's callback onPreparedForConnection returns list of available Nubocam Wifi Networks.
  • Android specific: NuboCamWizard's method connectToCamera takes WifiNetwork object (returned with onPreparedForConnection callback) as input parameter.
  • Android specific: NuboCamWizard has additional method disconnectFromNuboCamWifi.

class NuboCamWizard

NuboCamWizard(NuboCamWizardDelegate delegate);

Constructs NuboCamWizard instance.

prepareForConnection(Map<String, void *> options);

Prepares for connection process. Options map should contain "cameraId" (of disconnected camera) for restoration process or "zoneId" for adding process.

connectToCamera(WifiNetwork nuboCamWifiNetwork);

Connects to wifi network of chosen NuboCam.

iOS specific: user should connect to NuboCam wifi network manually using Settings app. After returning to app he should call this method (without parameters).

 Android specific: list of available wifi networks is returned by prepareForConnection callback. User should use one of returned object to pass as parameter of this function.

Carrier[] getListOfAvailableCarriers();

Returns list of Carriers to which NuboCam can be connected. Array will be empty if mobile setup option is not available.

refreshWifiList();

Refreshes list of WifiNetwork objects to which NuboCam can be connected.

connectCameraToNetwork(NetworkInterface network, String cameraName);

Connects NuboCam to provided network with given camera name (both WifiNetwork and AccessPointName are inherited from NetworkInterface).

cancelCurrentOperation();

Cancels current operation. No callbacks will be triggered.

disconnectFromNuboCamWifi();

Android specific: Disconnects device from NuboCam Wi-Fi access point.

protocol NuboCamWizardDelegate

@required onPreparedForConnection(WifiNetwork[] nuboCamWifiNetworks);

Called when SDK is ready for NuboCam connection.

Android specific: returns list of available NuboCam wifi networks to connect. One of objects should be used with connectToCamera method.

@required onConnectedToCamera(MobileSetupOption option);

Called when SDK established connection with NuboCam. Now user can retrieve list of wifi. Option enumeration determines available mobile setup options.

@optional onWifiListRefreshed(WifiNetwork[] networks);

Returns list of Wifi networks to which NuboCam can be connected.

@optional onDisconnectedFromCameraUnexpectedly();

Will be called if NuboCam will try to connect to cloud with previously setup sim. Expect onFinished or onError callback after this one.

@required onFinished(Long cameraId);

If everything went ok, will get called after the NuboCam has been added/restored.

@required onError(MobileSDKError error);

Will get called if there's an error in the process of adding/restoring NuboCam.

enum MobileSetupOption

case notAvailable
case oldFirmware
case pinRequired
case ownSim 

abstract class NetworkInterface

Empty abstraction which represents some network interface.

class WifiNetwork : NetworkInterface

String getSsid();

Returns SSID of wifi network.

String getEncryption();

Returns encryption of wifi network.

Int getStrengthPercentage();

Returns strength of wifi network in range (0..100].

String password;

Password of wifi network.

class AccessPointName : NetworkInterface

AccessPointName(String name, String username, String password);

Constructs AccessPointName instance.

String getName();

Returns name of access point name.

String getUsername();

Returns username of access point name.

String getPassword(); 

Returns password of access point name.

class Carrier 

String getName();

Returns name of carrier.

String getMcc();

Returns MCC of carrier.

String getMnc();

Returns MNC of carrier.

String getCountryIso();

Returns country ISO of carrier.

AccessPointName[] getAccessPointNamesList(); 

Returns list of APNs of carrier.