BS2_AddOsdpStandardDevice
+ v2.9.1 CoreStation40 Add the OSDP device with specified information to the given channel on the master device.
Addable devices can be checked in BS2_GetAvailableOsdpStandardDevice or BS2_GetOsdpStandardConfig.
If Suprema devices and OSDP standard connection devices are mixed and connected to the master device, can get the slave devices in batches with BS2_GetRS485ConfigEx.
Declaration
#include "BS_API.h"
int BS2_AddOsdpStandardDevice(void* context, uint32_t deviceId, uint32_t channelIndex, const BS2OsdpStandardDeviceAdd* osdpDevice, uint32_t* outChannelIndex);
Parameter
-
[In]
context: Context -
[In]
deviceId: Device Identifier -
[In]
channelIndex: Device's channel identifier -
[In]
osdpDevice: OSDP device information to add -
[Out]
outChannelIndex: Pointer to store the channel identifier of the added OSDP device
Return Value
If successfully done, BS_SDK_SUCCESS will be returned. If there is an error, the corresponding error code will be returned.
Sample Code
BS2OsdpStandardDeviceAvailable availDevice = { 0, };
BS2OsdpStandardDeviceAdd addDevice = { 0, };
BS2_DEVICE_ID masterID = Utility::selectDeviceID(deviceList, false, false);
cout << "Now add a OSDP device." << endl;
addDevice.deviceID = Utility::selectSlaveID();
uint32_t channelIndex = 0;
for (int idx = 0; idx < availDevice.numOfChannel; idx++)
{
for (int didx = 0; didx < availDevice.channels[idx].numOsdpAvailableDevice; didx++)
{
if (availDevice.channels[idx].deviceIDs[didx] == addDevice.deviceID)
channelIndex = availDevice.channels[idx].channelIndex;
}
}
addDevice.osdpID = (uint8_t)Utility::getInput<uint32_t>("Please enter the OSDP ID. [0 ~ 126]");
addDevice.useSecureSession = Utility::isYes("Does the OSDP device use secure communication?");
addDevice.deviceType = BS2_DEVICE_TYPE_3RD_OSDP_DEVICE;
addDevice.activate = 1;
uint32_t outChannelIndex(0);
int sdkResult = BS2_AddOsdpStandardDevice(context_, masterID, channelIndex, &addDevice, &outChannelIndex);
if (BS_SDK_SUCCESS != sdkResult)
printf("BS2_AddOsdpStandardDevice call failed: %d", sdkResult);
return sdkResult;
BS2OsdpStandardDeviceAdd addDevice = Util.AllocateStructure<BS2OsdpStandardDeviceAdd>();
Util.HighlightLine(">>>> Now add a OSDP device.", "add");
addDevice.deviceID = Util.GetInputSlaveID();
UInt32 channelIndex = 0;
for (int idx = 0; idx < allDevice.numOfChannel; idx++)
{
for (int didx = 0; didx < allDevice.channels[idx].numOsdpAvailableDevice; didx++)
{
if (allDevice.channels[idx].deviceIDs[didx] == addDevice.deviceID)
channelIndex = allDevice.channels[idx].channelIndex;
}
}
Util.HighlightLine(">>>> Please enter the OSDP ID. [0 ~ 126]", "OSDP ID");
Console.Write(">>>> ");
addDevice.osdpID = Util.GetInput((byte)0);
Util.HighlightLine(">>>> Does the OSDP device use secure communication? [Y/n]", "use secure communication");
Console.Write(">>>> ");
addDevice.useSecureSession = Convert.ToByte(Util.IsYes());
addDevice.deviceType = Convert.ToByte(BS2DeviceTypeEnum.THIRD_OSDP_DEVICE);
addDevice.activate = Convert.ToByte(true);
UInt32 outChannelIndex = 0;
BS2ErrorCode result = (BS2ErrorCode)API.BS2_AddOsdpStandardDevice(sdkContext, deviceID, channelIndex, ref addDevice, out outChannelIndex);
if (result != BS2ErrorCode.BS_SDK_SUCCESS)
Console.WriteLine("Got error({0}).", result);
else
Console.WriteLine("Call success.");
return result;
See Also
BS2_GetAvailableOsdpStandardDevice