https://github.com/tricera-energy/httpcontrol-panel
Panel to send HTTP post request to a grafana backend api via buttons, switches, textinput or sliders
https://github.com/tricera-energy/httpcontrol-panel
grafana-panel grafana-plugin http post
Last synced: 10 months ago
JSON representation
Panel to send HTTP post request to a grafana backend api via buttons, switches, textinput or sliders
- Host: GitHub
- URL: https://github.com/tricera-energy/httpcontrol-panel
- Owner: TRICERA-energy
- License: apache-2.0
- Created: 2022-11-28T15:31:42.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-01-30T12:41:19.000Z (over 2 years ago)
- Last Synced: 2025-05-14T03:33:04.295Z (about 1 year ago)
- Topics: grafana-panel, grafana-plugin, http, post
- Language: TypeScript
- Homepage:
- Size: 543 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# HTTP Control Panel
## Index
- [Description](#description)
- [Installation](#installation)
- [Settings](#settings)
- [Connection](#connection)
- [Groups](#groups)
- [Controls](#controls)
- [Button](#button)
- [Switch](#switch)
- [Text Input](#text-input)
- [Slider](#slider)
- [Panel](#panel)
- [Development](#development)
## Description
This panel plugin allows to publish data to a grafana backend api.
It is possible to define multiple groups with
multiple controllers of type [Button](#button), [Switch](#switch),
[Text Input](#text-input) and [Slider](#slider).
## Installation
- Via the release binary:
Download the latest [Release](https://github.com/TRICERA-energy/httpcontrol-panel/releases) and unzip it into the grafana plugin folder.
- Build your own binaries:
You can build the binaries by yourself.
1. Clone this repository to your grafana plugin folder.
2. Run `yarn` (Make sure you have nodejs and yarn installed)
3. Run `yarn build`
- Load the plugin directly into a grafana container
```
docker run -d -p 3000:3000 -e "GF_INSTALL_PLUGINS=https://github.com/TRICERA-energy/httpcontrol-panel/releases/download/v1.0.0/triceraenergy-httpcontrol-panel-1.0.0.zip;httpcontrol-panel" --name=grafana grafana/grafana
```
## Settings
### Connection
Grafana backend plugin api is located under
`api/plugins//resources/`
### Groups
A new group can be added via the `Add Group` button.
**Note:** You can't reorder the controls currently in the panel or group settings section. Make sure to add the controls in the order you want.
### Controls
A new control can be added via the `Add Control` button. Beside the _Name_, _Color_ and _Publish Topic_ each control type has specific settings.
#### Button
The button sends the given _Value_ to the given _POST PATH_. For more customization an icon provided by grafana can be selected.
#### Switch
The switch sends the given _Value On_ on true and the given _Value Off_ on false. Switches also listen to the given _API Listen Path_ and read there state from given _Listen Path_. This path should be a valid json path and the value should be boolean convertable.
Let's assume the following message is read from the _API Listen Path_:
```json
{
"switch": true,
"array": [true, false, false, true]
}
```
If the _Listen Path_ is `switch` the state would be true.
With a _Listen Path_ of `array[1]` the state would be false.
#### Text Input
Text input acts like a [Button](#button) control with the difference that you insert the message directly in the panel instead in the settings. This allows to send different messages via one button.
#### Slider
With the slider you can control a number range between _From_ and _To_ value. Like the [Switch](#switch) it listens to the given _API Listen Path_ and read there state from given _Listen Path_. The value should be number convertable.
## Panel
By default the panel contains one `Error` tab which shows the last 200 errors occuried within the panel.
## Development
1. Install dependencies
```bash
yarn install
```
2. Build plugin in development mode or run in watch mode
```bash
yarn dev
# or
yarn watch
```
3. Build plugin in production mode
```bash
yarn build
```
4. Run the tests (using Jest)
```bash
# Runs the tests and watches for changes
yarn test
# Exists after running all the tests
yarn lint:ci
```
5. Spin up a Grafana instance and run the plugin inside it (using Docker)
```bash
yarn server
```
6. Run the E2E tests (using Cypress)
```bash
# Spin up a Grafana instance first that we tests against
yarn server
# Start the tests
yarn e2e
```
7. Run the linter
```bash
yarn lint
# or
yarn lint:fix
```