This interface provides method to get epaper module version.

DOMString getVersion();

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Return Value :

• DOMString : DOMString Epaper plug-in version

Exceptions :

• WebAPIException
  • with error type NotSupportedError, if this feature is not supported
  • with error type SecurityError, if the application does not have the privilege to call this method

Since : 8.0

Code Example :

var Version = null;

try {
  Version = webapis.epaper.getVersion();
} catch (e) {
  console.log("[getVersion] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

if (null !== Version) {
  console.log("[getVersion] call syncFunction type: " + Version);
}

It can be set a time delay for entering sleep mode, and upon setting, the delay time begins to count.
If the TIME setting value changes, it will be counted again from the beginning according to the newly set value.

void setAutoSleepTime(SleepTime delayTime);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Parameters :

• delayTime : Sleep delay mode

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method
  • with error type NotSupportedError, if this feature is not supported
  • with error type UnknownError, for any other error
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type

Since : 8.0

Code Example :

var delayTime = "30MIN";
try {
  webapis.epaper.setAutoSleepTime(delayTime);
} catch (e) {
  console.log("[setAutoSleepTime] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

Get the value of the time delay for entering sleep mode. OFF Value is when the delay time is not set.

SleepTime getAutoSleepTime();

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Return Value :

• SleepTime : SleepTime waiting time beginning to count for entering sleep mode.

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method
  • with error type NotSupportedError, if this feature is not supported
  • with error type UnknownError, for any other error

Since : 8.0

Code Example :

var time = null;
try {
  time = webapis.epaper.getAutoSleepTime();
  console.log("[getAutoSleepTime] call syncFunction type: " + time);
} catch (e) {
  console.log("[getAutoSleepTime] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

It can be reset a time delay count for entering sleep mode, the delay time begins again to count.

void resetAutoSleepTime();

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method
  • with error type NotSupportedError, if this feature is not supported
  • with error type UnknownError, for any other error

Since : 8.0

Code Example :

try {
  webapis.epaper.resetAutoSleepTime();
} catch (e) {
  console.log("[resetAutoSleepTime] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

Allows the device to directly enter sleep mode.

void goToSleep();

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method
  • with error type NotSupportedError, if this feature is not supported
  • with error type UnknownError, for any other error

Since : 8.0

Code Example :

try {
  webapis.epaper.goToSleep();
} catch (e) {
  console.log("[goToSleep] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

It can be set a schedule for the device to wake up after a certain period of time the unit is in seconds. The time setting is up to one week.(1 ~ 604800 sec)
It can be set more than one wake up time and manage the returned ID to utilize the get or cancel API. 최대 일주일까지 wake up 시간을 설정할 수 있다.(1 ~ 604800 초)

long setScheduleWakeupTime(WakeupTime wakeupTime);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Parameters :

• wakeupTime : wakeup time information

Return Value :

• long : long wakeup timer id

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method
  • with error type NotSupportedError, if this feature is not supported
  • with error type UnknownError, for any other error
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type

Since : 8.0

Code Example :

var wakeup_time = {
  "year" 	   : 2024,
  "month"    : 12,
  "day"	   : 15,
  "hour"     : 8,
  "minute"   : 55,
  "second"   : 43
}
try {
  var timerId = webapis.epaper.setScheduleWakeupTime(wakeup_time);
  console.log("[setScheduleWakeupTime] call syncFunction type: " + timerId);
} catch (e) {
  console.log("[setScheduleWakeupTime] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

Retrieve the previously set value for the wakeup date time.

WakeupTime getScheduleWakeupTime(long timerID);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Parameters :

• timerID : timer id of wakeup time

Return Value :

• WakeupTime : WakeupTime Wakeup date time

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method
  • with error type NotSupportedError, if this feature is not supported
  • with error type UnknownError, for any other error
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type

Since : 8.0

Code Example :

var date;
var id = 10; // return value of setScheduleWakeupTime()
try {
  data = webapis.epaper.getScheduleWakeupTime(id);
  console.log("[getScheduleWakeupTime] call syncFunction type: " + date);
} catch (e) {
  console.log("[getScheduleWakeupTime] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

cancel ScheduleWakeupTime the previously set value for the wakeup time.

void cancelScheduleWakeupTime(long timerID);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Parameters :

• timerID : timer id of wakeup time

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method
  • with error type NotSupportedError, if this feature is not supported
  • with error type UnknownError, for any other error
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type

Since : 8.0

Code Example :

var id = 10; // return value of setScheduleWakeupTime()
try {
  webapis.epaper.cancelScheduleWakeupTime(id);
  console.log("[cancelScheduleWakeupTime] call syncFunction type: " );
} catch (e) {
  console.log("[cancelScheduleWakeupTime] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

It can be set network standby mode.

void setNetworkStandby(Activation mode);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Parameters :

• mode : actovate mode of network stanby

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method
  • with error type NotSupportedError, if this feature is not supported
  • with error type UnknownError, for any other error
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type

Since : 8.0

Code Example :

var mode = "ON";
try {
  webapis.epaper.setNetworkStandby(mode);
} catch (e) {
  console.log("[setNetworkStandby] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

Get the value of Network standby mode.

Activation getNetworkStandby();

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Return Value :

• Activation : Activation mode of network stanby

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method
  • with error type NotSupportedError, if this feature is not supported
  • with error type UnknownError, for any other error

Since : 8.0

Code Example :

var mode = null;
try {
  mode = webapis.epaper.getNetworkStandby();
} catch (e) {
  console.log("[getNetworkStandby] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if (mode) {
  console.log("[getNetworkStandby] call syncFunction type: " + mode);
}

Get Scheduled Boot reason of device power wake up.

boolean isScheduledPlayBootReason();

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Return Value :

• boolean : Bool True(1) or False(0) if boot reason scheduled power wake up

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method
  • with error type NotSupportedError, if this feature is not supported

Since : 8.0

Code Example :

var reason;
try {
  reason = webapis.epaper.isScheduledPlayBootReason();
} catch (e) {
  console.log("[isScheduledPlayBootReason] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if (reason) {
  console.log("[isScheduledPlayBootReason] call syncFunction type: " + reason);
}

Sets the battery warning icon display mode to ON or OFF.

void setBatteryWarningIconDisplay(Activation mode);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Parameters :

• mode : of Battery Warning Icon

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method
  • with error type NotSupportedError, if this feature is not supported
  • with error type UnknownError, for any other error
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type

Since : 8.0

Code Example :

var mode = "ON";
try {
  webapis.epaper.setBatteryWarningIconDisplay(mode);
} catch (e) {
  console.log("[setBatteryWarningIconDisplay] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

Gets the battery warning icon display mode.

Activation getBatteryWarningIconDisplay();

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Return Value :

• Activation : Activation mode of Battery Warning Icon

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method
  • with error type NotSupportedError, if this feature is not supported
  • with error type UnknownError, for any other error

Since : 8.0

Code Example :

var mode = null;
try {
  mode = webapis.epaper.getBatteryWarningIconDisplay();
} catch (e) {
  console.log("[getBatteryWarningIconDisplay] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if (mode) {
  console.log("[getBatteryWarningIconDisplay] call syncFunction type: " + mode);
}

Allows the device to refresh screen.

void screenRefreshNow();

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method
  • with error type NotSupportedError, if this feature is not supported
  • with error type UnknownError, for any other error

Since : 8.0

Code Example :

try {
  webapis.epaper.screenRefreshNow();
} catch (e) {
  console.log("[screenRefreshNow] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

Sets the interval used for periodic refresh of screen.
The setting is turned off after a specific time period following the refresh screen.

void setScreenRefreshTime(RefreshTime refreshTime);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Parameters :

• refreshTime : Object refresh screen time

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method
  • with error type NotSupportedError, if this feature is not supported
  • with error type UnknownError, for any other error
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type

Since : 8.0

Code Example :

var refreshTime = {
  "hour" : 6,
  "minute" : 15
};
try {
  webapis.epaper.setScreenRefreshTime(refreshTime);
} catch (e) {
  console.log("[setScreenRefreshTime] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

Gets the time of refresh screen.

RefreshTime getScreenRefreshTime();

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Return Value :

• RefreshTime : long time of refresh screen

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method
  • with error type NotSupportedError, if this feature is not supported
  • with error type UnknownError, for any other error

Since : 8.0

Code Example :

var mode;
try {
  mode = webapis.epaper.getScreenRefreshTime();
} catch (e) {
  console.log("[getScreenRefreshTime] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if (mode) {
  console.log("[getScreenRefreshTime] call syncFunction type: " + mode);
}

Selectively Deactivate the LED of an ePaper device in a specific color scheme..

void setLEDStateOff(LedColor color);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Parameters :

• color : led color Information

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method
  • with error type NotSupportedError, if this feature is not supported
  • with error type UnknownError, for any other error
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type

Since : 8.0

Code Example :

var color = "LED_GREEN";
try {
  webapis.epaper.setLEDStateOff(color);
} catch (e) {
  console.log("[setLEDStateOff] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

Selectively activate the LED of an ePaper device in a specific color scheme..

void setLEDStateOn(LedOnInfo info);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Parameters :

• info : led Control Information of epaper

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method
  • with error type NotSupportedError, if this feature is not supported
  • with error type UnknownError, for any other error
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type

Since : 8.0

Code Example :

var info = {
  "color" : "LED_GREEN",
  "duration" : 150
};
try {
  webapis.epaper.setLEDStateOn(info);
} catch (e) {
  console.log("[setLEDStateOff] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

Selectively blink the LED of an ePaper device in a specific color scheme..

void setLEDStateBlink(LedBlinkInfo info);

Product : B2B (LFD)

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/systemcontrol

Parameters :

• info : led blink Information of epaper

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method
  • with error type NotSupportedError, if this feature is not supported
  • with error type UnknownError, for any other error
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type

Since : 8.0

Code Example :

var info = {
  "color" : "LED_GREEN",
  "onIntervalTime" : "LED_250MS",
  "offIntervalTime" : "LED_250MS",
  "duration" : 180
};
try {
  webapis.epaper.setLEDStateBlink(info);
} catch (e) {
  console.log("[setLEDStateBlink] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}