Accessories Pushbutton Foot Pedal - ResgreenGroup/Botway-Documentation GitHub Wiki

Current Location: Home->Accessories->Pushbutton\Foot Pedal

Pushbutton

The Pushbutton device has five physical features: The power switch, the charging port, the wireless setup button, the OLED display and the functional button.

1. Power switch

The power switch is located on the left-hand side of the device. It turns the device on and off. When the side with the circle printed on it is pressed in, the device will turn on. When the side with the line printed on it is pressed in, the device will turn off.

2. Charging port and Charger

The charging port is located on the left-hand side of the device next to the power switch. It allows the device to be recharged. A charger will also be sold with the device. The charger takes in 100-240V AC current at 50 or 60 hertz and 500 mA and outputs 5V DC current at 2 Amps. The specific model sold with the device is CS-0502000. The charging port on the device accepts 5.5mm outer diameter barrel jacks, with an adapter included. The tip polarity is positive.

3. Wireless Setup Button

The wireless setup button is on the right-hand side. It will be used when connecting the device to the wireless network and its use is detailed in the wireless connection page.

4. OLED Display

The OLED display is on the front of the device. It shows the status of the Pushbutton and other pieces of useful information. The date and time are on shown on the bottom of the screen. The associated software and number of recorded presses are on top of the screen; the button counter uses a handshake (sent/received) mechanism, with number of presses registered by the device on the left and the number of presses registered by the software on the right. The device’s name in BotWay and button press status is in the middle. Names are not yet changeable.

5. Functional Button

The Functional button is located on the front of the device underneath the display. It sends an “on” action to the software over the wireless network when pressed and released.

Foot Pedal

The Foot Pedal device is very similar in both form and function to the Pushbutton device. It has five physical features as well: the power switch, charging port, the wireless setup button, display, and foot pedal.

1. Power switch

2. Charging port and Charger

3. Wireless Setup Button

The wireless setup button is on the right-hand side. It will be used when connecting the device to the wireless network and its use is detailed in the wireless connection page.

4. Foot Pedal

The foot pedal connects to the device via a cable located on the right-hand side of the device next to the wireless setup button. The function of the foot pedal is identical to the functional button on the Pushbutton device: it sends an “on” action when pressed and released. The cord is eight feet long and its exposed length can be change by loosening the hexagonal nut at the base of the cable, inserting or removing excess cable from the inside of the device, and re-tightening the hexagonal nut.

5. OLED Display

Interactions with Software, namely BotWay.

These devices are meant to be used with BotWay; however, any software that reads MQTT will be able to recognize the signals sent by these devices. These devices output “on” actions which need to be interpreted by the software. The response by the associated system needs to be tailored in the software. Example uses are detailed here.

Examples

Buttons send signals to BotWay that contain information about the device. BotWay receives the signal in the form of a single ID string made up of the device ID and the number assigned to the pressed button (each device can have as many as four functional buttons on its front face). BotWay needs to be told what to do once it recognizes the ID; it can trigger one of four actions unless a trigger is applied to it.

Add a job to the job queue.
Release a robot from a tag onto a specific route.
Pause the job queue and halt robot action.
Resume the job queue.