Class PlugSchedule

Hierarchy

default
- PlugSchedule

Index

Constructors

Properties

apiModuleName childId? device nextAction

Methods

addRule deleteAllRules deleteRule editRule eraseStats getDayStats getMonthStats getNextAction getRule getRules setOverallEnable

Constructors

constructor

new PlugSchedule(device, apiModuleName, childId?): PlugSchedule
Parameters
- device: Plug
- apiModuleName: string
- Optional childId: string
Returns PlugSchedule
Overrides Schedule.constructor
- Defined in src/plug/schedule.ts:38

Properties

`Readonly` apiModuleName

apiModuleName: string

`Optional` `Readonly` childId

childId?: string

`Readonly` device

device: Plug

nextAction

nextAction: undefined | ScheduleNextActionResponse

Methods

addRule

addRule(rule, sendOptions?): Promise<{
id: string;
}>
Adds Schedule rule.

Sends schedule.add_rule command and returns rule id. Supports childId.
Parameters
- rule: PlugScheduleRuleInput
- Optional sendOptions: SendOptions
Returns Promise<{
id: string;
}>
parsed JSON response

Throws
ResponseError
Overrides Schedule.addRule
- Defined in src/plug/schedule.ts:53

deleteAllRules

deleteAllRules(sendOptions?): Promise<unknown>
Deletes All Schedule Rules.

Sends schedule.delete_all_rules command. Supports childId.
Parameters
- Optional sendOptions: SendOptions
Returns Promise<unknown>
parsed JSON response

Throws
ResponseError
Inherited from Schedule.deleteAllRules
- Defined in src/shared/schedule.ts:347

deleteRule

deleteRule(id, sendOptions?): Promise<unknown>
Deletes Schedule Rule.

Sends schedule.delete_rule command. Supports childId.
Parameters
- id: string
- Optional sendOptions: SendOptions
Returns Promise<unknown>
parsed JSON response

Throws
ResponseError
Inherited from Schedule.deleteRule
- Defined in src/shared/schedule.ts:364

editRule

editRule(rule, sendOptions?): Promise<unknown>
Edits Schedule rule.

Sends schedule.edit_rule command and returns rule id. Supports childId.
Parameters
- rule: PlugScheduleRuleInput & {
  id: string;
  }
- Optional sendOptions: SendOptions
Returns Promise<unknown>
parsed JSON response

Throws
ResponseError
Overrides Schedule.editRule
- Defined in src/plug/schedule.ts:90

eraseStats

eraseStats(sendOptions?): Promise<unknown>
Erase Usage Statistics.

Sends schedule.erase_runtime_stat command. Supports childId.
Parameters
- Optional sendOptions: SendOptions
Returns Promise<unknown>
parsed JSON response

Throws
ResponseError
Inherited from Schedule.eraseStats
- Defined in src/shared/schedule.ts:444

getDayStats

getDayStats(year, month, sendOptions?): Promise<unknown>
Get Daily Usage Statistics.

Sends schedule.get_daystat command. Supports childId.
Parameters
- year: number
- month: number
- Optional sendOptions: SendOptions
Returns Promise<unknown>
parsed JSON response

Throws
ResponseError
Inherited from Schedule.getDayStats
- Defined in src/shared/schedule.ts:403

getMonthStats

getMonthStats(year, sendOptions?): Promise<unknown>
Get Monthly Usage Statistics.

Sends schedule.get_monthstat command. Supports childId.
Parameters
- year: number
- Optional sendOptions: SendOptions
Returns Promise<unknown>
parsed JSON response

Throws
ResponseError
Inherited from Schedule.getMonthStats
- Defined in src/shared/schedule.ts:424

getNextAction

getNextAction(sendOptions?): Promise<ScheduleNextActionResponse>
Gets Next Schedule Rule Action.

Requests schedule.get_next_action. Supports childId.
Parameters
- Optional sendOptions: SendOptions
Returns Promise<ScheduleNextActionResponse>
Throws
ResponseError
Inherited from Schedule.getNextAction
- Defined in src/shared/schedule.ts:237

getRule

getRule(id, sendOptions?): Promise<ScheduleRuleResponse>
Gets Schedule Rule.

Requests schedule.get_rules and return rule matching Id. Supports childId.
Parameters
- id: string
- Optional sendOptions: SendOptions
Returns Promise<ScheduleRuleResponse>
Throws
ResponseError

Throws
Error
Inherited from Schedule.getRule
- Defined in src/shared/schedule.ts:282

getRules

getRules(sendOptions?): Promise<ScheduleRulesResponse>
Gets Schedule Rules.

Requests schedule.get_rules. Supports childId.
Parameters
- Optional sendOptions: SendOptions
Returns Promise<ScheduleRulesResponse>
Throws
ResponseError
Inherited from Schedule.getRules
- Defined in src/shared/schedule.ts:261

setOverallEnable

setOverallEnable(enable, sendOptions?): Promise<unknown>
Enables or Disables Schedule Rules.

Sends schedule.set_overall_enable command. Supports childId.
Parameters
- enable: boolean
- Optional sendOptions: SendOptions
Returns Promise<unknown>
parsed JSON response

Throws
ResponseError
Inherited from Schedule.setOverallEnable
- Defined in src/shared/schedule.ts:381

Generated using TypeDoc