Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated OctoLight API information #1310

Merged
merged 4 commits into from
Jul 15, 2024
Merged

Updated OctoLight API information #1310

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
900b6ad
Updated OctoLight API information
thomst08 Jul 10, 2024
590e2b1
Update notices.yaml
thomst08 Jul 10, 2024
24ba14e
Removed API info from info
thomst08 Jul 10, 2024
1f9f095
Removed notification
thomst08 Jul 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 2 additions & 13 deletions _plugins/octolight.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,16 +158,5 @@ Currently, you can configure settings:


## API
Base API URL: `GET http://YOUR_OCTOPRINT_SERVER/api/plugin/octolight?action=ACTION_NAME`

This API always returns updated light state in JSON: `{state: true}` <br />
Any API call will require a API key with the "Control" permission. Without this, you will receive a 403 error.

_(if the action parameter not given, the action toggle will be used by default)_
#### Actions
- **toggle** (default action): Toggle light switch on/off.
- **turnOn**: Turn on light.
- **turnOff**: Turn off light.
- **getState**: Get current light switch state.
- **delayOff**: Turn on light and setup timer to shutoff light after delay time, note, `&delay=VALUE` can be added to the URL to override the default time value.
- **delayOffStop**: Testing for shutting off timer and light.

**Note:** OctoLight supports API calls, please go to the following link to check the latest information: https://github.com/thomst08/OctoLight#api
Loading