Skip to content

Built in Grove APIs

Tejas Shah edited this page Nov 22, 2017 · 5 revisions

Below is the built-in Grove APIs list. You can find latest APIs on App's APIs page.

Grove/Module Name APIs (Update on 2017-04-20)
GroveAirquality "GET /v1/node/GroveAirqualityA0/quality -> int quality"
GroveDust "GET /v1/node/GroveDustD2/dust -> float dust"
GroveDryReedRelay "GET /v1/node/GroveDryReedRelayD1/onoff_status -> int onoff"
"POST /v1/node/GroveDryReedRelayD1/onoff/{int onoff}"
GroveButton "GET /v1/node/GroveButtonD0/pressed -> uint8_t pressed"
"Event GroveButtonD0 button_pressed"
GroveCo2MhZ16 "GET /v1/node/GroveCo2MhZ16UART0/temperature -> float temperature"
"GET /v1/node/GroveCo2MhZ16UART0/concentration -> float concentration"
"GET /v1/node/GroveCo2MhZ16UART0/concentration_and_temperature -> float concentration, float temperature"
GroveDigitalLight "GET /v1/node/GroveDigitalLightI2C0/lux -> uint32_t lux"
GroveBaroBMP280 "GET /v1/node/GroveBaroBMP280I2C0/temperature -> float temperature"
"GET /v1/node/GroveBaroBMP280I2C0/altitude -> float altitude"
"GET /v1/node/GroveBaroBMP280I2C0/pressure -> int32_t pressure"
"GET /v1/node/GroveBaroBMP085I2C0/temperature -> float temperature"
"GET /v1/node/GroveBaroBMP085I2C0/altitude -> float altitude"
"GET /v1/node/GroveBaroBMP085I2C0/pressure -> int32_t pressure"
CytronMD13S "GET /v1/node/CytronMD13SUART0/direction -> int direction"
"GET /v1/node/CytronMD13SUART0/speed -> float speed"
"GET /v1/node/CytronMD13SUART0/speed_dir -> float speed, int direction"
"POST /v1/node/CytronMD13SUART0/speed/{float speed}"
"POST /v1/node/CytronMD13SUART0/direction/{int direction}"
"POST /v1/node/CytronMD13SUART0/speed_dir/{float speed}/{int direction}"
GroveElecMagnet "GET /v1/node/GroveElecMagnetD1/onoff_status -> int onoff"
"POST /v1/node/GroveElecMagnetD1/onoff/{int onoff}"
GroveEL "GET /v1/node/GroveELD0/onoff_status -> int onoff"
"POST /v1/node/GroveELD0/onoff/{int onoff}"
GenericDIn "GET /v1/node/GenericDInD0/edge_rise_since_last_read -> uint32_t rises"
"GET /v1/node/GenericDInD0/input -> uint8_t input"
"GET /v1/node/GenericDInD0/edge_fall_since_last_read -> uint32_t falls"
"Event GenericDInD0 input_changed"
"Event GenericDInD0 input_rise"
"Event GenericDInD0 input_fall"
GenericAIn "GET /v1/node/GenericAInA0/analog -> int analog"
"GET /v1/node/GenericAInA0/voltage -> float volt"
GroveEncoder "GET /v1/node/GroveEncoderUART0/position -> int32_t position"
"POST /v1/node/GroveEncoderUART0/reset_position/{int32_t position}"
"POST /v1/node/GroveEncoderUART0/enable_acceleration/{uint8_t enable}"
"Event GroveEncoderUART0 encoder_position"
GenericPWMOut "GET /v1/node/GenericPWMOutD2/pwm -> float duty_percent, uint32_t freq"
"POST /v1/node/GenericPWMOutD2/pwm/{float duty_percent}"
"POST /v1/node/GenericPWMOutD2/pwm_with_freq/{float duty_percent}/{uint32_t freq}"
GenericDOut "GET /v1/node/GenericDOutD1/onoff_status -> int onoff"
"POST /v1/node/GenericDOutD1/onoff/{int onoff}"
"POST /v1/node/GenericDOutD1/high_pulse/{int ms}"
"POST /v1/node/GenericDOutD1/low_pulse/{int ms}"
GroveUART "POST /v1/node/GroveUARTUART0/base64_string/{char *b64_str}"
"POST /v1/node/GroveUARTUART0/baudrate/{uint8_t index}"
"POST /v1/node/GroveUARTUART0/string/{char *str}"
"Event GroveUARTUART0 uart_rx"
GroveIREmit "GET /v1/node/GroveIREmitD2/protocal_parameters -> uint8_t start_h, uint8_t start_l, uint8_t n_short, uint8_t n_long"
"POST /v1/node/GroveIREmitD2/data_hex/{char *data_hex}"
"POST /v1/node/GroveIREmitD2/protocol_parameters/{uint8_t start_h}/{uint8_t start_l}/{uint8_t n_short}/{uint8_t n_long}"
"POST /v1/node/GroveIREmitD2/data_hex_in_freq/{uint16_t freq_khz}/{char *data_hex}"
GroveI2CMotorDriver "POST /v1/node/GroveI2CMotorDriverI2C0/i2c_address/{uint8_t addr_7bits}"
"POST /v1/node/GroveI2CMotorDriverI2C0/enable_stepper_mode/{uint8_t direction}/{uint8_t speed}"
"POST /v1/node/GroveI2CMotorDriverI2C0/disable_stepper_mode"
"POST /v1/node/GroveI2CMotorDriverI2C0/dcmotor1_change_direction"
"POST /v1/node/GroveI2CMotorDriverI2C0/dcmotor1_resume"
"POST /v1/node/GroveI2CMotorDriverI2C0/dcmotor_speed/{uint8_t speed_m1}/{uint8_t speed_m2}"
"POST /v1/node/GroveI2CMotorDriverI2C0/dcmotor2_change_direction"
"POST /v1/node/GroveI2CMotorDriverI2C0/stepper_steps/{uint8_t steps}"
"POST /v1/node/GroveI2CMotorDriverI2C0/dcmotor2_resume"
"POST /v1/node/GroveI2CMotorDriverI2C0/dcmotor2_break"
"POST /v1/node/GroveI2CMotorDriverI2C0/dcmotor1_break"
GroveHall "GET /v1/node/GroveHallD0/vout -> uint8_t vout"
"Event GroveHallD0 state_off"
"Event GroveHallD0 state_on"
GroveI2CAdc "GET /v1/node/GroveI2CAdcI2C0/adc -> uint32_t adc_reading"
"GET /v1/node/GroveI2CAdcI2C0/voltage -> float volt"
GroveI2cFmReceiver "GET /v1/node/GroveI2cFmReceiverI2C0/frequency -> uint16_t frequency"
"GET /v1/node/GroveI2cFmReceiverI2C0/volume -> uint8_t level"
"GET /v1/node/GroveI2cFmReceiverI2C0/signal_level -> uint8_t rssi"
"GET /v1/node/GroveI2cFmReceiverI2C0/mute_status -> bool muted"
"POST /v1/node/GroveI2cFmReceiverI2C0/mute/{bool mute}"
"POST /v1/node/GroveI2cFmReceiverI2C0/volume/{uint8_t level}"
"POST /v1/node/GroveI2cFmReceiverI2C0/frequency/{uint16_t frequency}"
GroveGesture "GET /v1/node/GroveGestureI2C0/motion -> uint8_t motion"
"Event GroveGestureI2C0 gesture"
GroveIRDistanceInterrupter "GET /v1/node/GroveIRDistanceInterrupterD1/approach -> uint8_t approach"
"Event GroveIRDistanceInterrupterD1 ir_approached"
GroveLCDRGB "POST /v1/node/GroveLCDRGBI2C0/display_off"
"POST /v1/node/GroveLCDRGBI2C0/clear"
"POST /v1/node/GroveLCDRGBI2C0/float/{uint8_t row}/{uint8_t col}/{float f}/{uint8_t decimal}"
"POST /v1/node/GroveLCDRGBI2C0/backlight_color_rgb/{uint8_t r}/{uint8_t g}/{uint8_t b}"
"POST /v1/node/GroveLCDRGBI2C0/base64_string/{uint8_t row}/{uint8_t col}/{char *b64_str}"
"POST /v1/node/GroveLCDRGBI2C0/scroll_right/{uint8_t speed}"
"POST /v1/node/GroveLCDRGBI2C0/scroll_left/{uint8_t speed}"
"POST /v1/node/GroveLCDRGBI2C0/string/{uint8_t row}/{uint8_t col}/{char *str}"
"POST /v1/node/GroveLCDRGBI2C0/integer/{uint8_t row}/{uint8_t col}/{int32_t i}"
"POST /v1/node/GroveLCDRGBI2C0/display_on"
"POST /v1/node/GroveLCDRGBI2C0/backlight_color/{uint8_t color_index}"
"POST /v1/node/GroveLCDRGBI2C0/stop_scroll"
GroveIRRecv "GET /v1/node/GroveIRRecvD0/protocol_parameters -> uint8_t start_h, uint8_t start_l, uint8_t n_short, uint8_t n_long"
"GET /v1/node/GroveIRRecvD0/last_data_recved -> uint16_t len, char *data"
"Event GroveIRRecvD0 ir_recv_data_hex"
"Event GroveIRRecvD0 ir_recv_data_len"
GroveLEDBar "GET /v1/node/GroveLEDBarUART0/bits -> uint16_t bits"
"POST /v1/node/GroveLEDBarUART0/toggle/{uint8_t led}"
"POST /v1/node/GroveLEDBarUART0/level/{float level}"
"POST /v1/node/GroveLEDBarUART0/single_led/{uint8_t led}/{float brightness}"
"POST /v1/node/GroveLEDBarUART0/bits/{uint16_t bits}"
"POST /v1/node/GroveLEDBarUART0/orientation/{uint8_t green_to_red}"
GroveLoudness "GET /v1/node/GroveLoudnessA0/loudness -> int loudness"
GroveMP3V2 "POST /v1/node/GroveMP3V2UART0/next"
"POST /v1/node/GroveMP3V2UART0/loop_all"
"POST /v1/node/GroveMP3V2UART0/pause"
"POST /v1/node/GroveMP3V2UART0/resume"
"POST /v1/node/GroveMP3V2UART0/index_to_play/{uint8_t index}"
"POST /v1/node/GroveMP3V2UART0/prev"
"POST /v1/node/GroveMP3V2UART0/volume/{uint8_t volume}"
GroveMagneticSwitch "GET /v1/node/GroveMagneticSwitchD0/approach -> uint8_t mag_approach"
"Event GroveMagneticSwitchD0 mag_approached"
GroveLuminance "GET /v1/node/GroveLuminanceA0/luminance -> float lux"
GrovePIRMotion "GET /v1/node/GrovePIRMotionD0/approach -> uint8_t approach"
"Event GrovePIRMotionD0 ir_moved"
GroveRecorder "POST /v1/node/GroveRecorderD1/play_once"
GroveMoisture "GET /v1/node/GroveMoistureA0/moisture -> uint16_t moisture"
GroveRelay "GET /v1/node/GroveRelayD2/onoff_status -> int onoff"
"POST /v1/node/GroveRelayD2/onoff/{int onoff}"
GroveOLED12864 "POST /v1/node/GroveOLED12864I2C0/clear"
"POST /v1/node/GroveOLED12864I2C0/float/{uint8_t row}/{uint8_t col}/{float f}/{uint8_t decimal}"
"POST /v1/node/GroveOLED12864I2C0/base64_string/{uint8_t row}/{uint8_t col}/{char *b64_str}"
"POST /v1/node/GroveOLED12864I2C0/scroll_right/{uint8_t start_row}/{uint8_t end_row}/{uint8_t speed}"
"POST /v1/node/GroveOLED12864I2C0/scroll_left/{uint8_t start_row}/{uint8_t end_row}/{uint8_t speed}"
"POST /v1/node/GroveOLED12864I2C0/string/{uint8_t row}/{uint8_t col}/{char *str}"
"POST /v1/node/GroveOLED12864I2C0/integer/{uint8_t row}/{uint8_t col}/{int32_t i}"
"POST /v1/node/GroveOLED12864I2C0/brightness/{uint8_t brightness}"
"POST /v1/node/GroveOLED12864I2C0/inverse_display/{uint8_t inverse_or_not}"
"POST /v1/node/GroveOLED12864I2C0/stop_scroll"
GroveMultiChannelGas "GET /v1/node/GroveMultiChannelGasI2C0/NH3 -> float concentration_ppm"
"GET /v1/node/GroveMultiChannelGasI2C0/CH4 -> float concentration_ppm"
"GET /v1/node/GroveMultiChannelGasI2C0/C4H10 -> float concentration_ppm"
"GET /v1/node/GroveMultiChannelGasI2C0/NO2 -> float concentration_ppm"
"GET /v1/node/GroveMultiChannelGasI2C0/C2H5OH -> float concentration_ppm"
"GET /v1/node/GroveMultiChannelGasI2C0/CO -> float concentration_ppm"
"GET /v1/node/GroveMultiChannelGasI2C0/C3H8 -> float concentration_ppm"
"GET /v1/node/GroveMultiChannelGasI2C0/H2 -> float concentration_ppm"
GroveOLED9696 "POST /v1/node/GroveOLED9696I2C0/clear"
"POST /v1/node/GroveOLED9696I2C0/float/{uint8_t row}/{uint8_t col}/{float f}/{uint8_t decimal}"
"POST /v1/node/GroveOLED9696I2C0/base64_string/{uint8_t row}/{uint8_t col}/{char *b64_str}"
"POST /v1/node/GroveOLED9696I2C0/scroll_right/{uint8_t start_row}/{uint8_t end_row}/{uint8_t speed}"
"POST /v1/node/GroveOLED9696I2C0/scroll_left/{uint8_t start_row}/{uint8_t end_row}/{uint8_t speed}"
"POST /v1/node/GroveOLED9696I2C0/string/{uint8_t row}/{uint8_t col}/{char *str}"
"POST /v1/node/GroveOLED9696I2C0/integer/{uint8_t row}/{uint8_t col}/{int32_t i}"
"POST /v1/node/GroveOLED9696I2C0/brightness/{uint8_t brightness}"
"POST /v1/node/GroveOLED9696I2C0/inverse_display/{uint8_t inverse_or_not}"
"POST /v1/node/GroveOLED9696I2C0/stop_scroll"
GroveSPDTRelay30A "GET /v1/node/GroveSPDTRelay30AD0/onoff_status -> int onoff"
"POST /v1/node/GroveSPDTRelay30AD0/onoff/{int onoff}"
GroveServo "GET /v1/node/GroveServoD1/angle -> int degree"
"POST /v1/node/GroveServoD1/angle/{int degree}"
"POST /v1/node/GroveServoD1/angle_motion_in_seconds/{int degree}/{int seconds}"
GroveRotaryAngle "GET /v1/node/GroveRotaryAngleA0/angle -> int angle"
GroveSolidStateRelay "GET /v1/node/GroveSolidStateRelayD2/onoff_status -> int onoff"
"POST /v1/node/GroveSolidStateRelayD2/onoff/{int onoff}"
GroveBME280 "GET /v1/node/GroveBME280I2C0/humidity -> uint32_t humidity"
"GET /v1/node/GroveBME280I2C0/temperature -> float temperature"
"GET /v1/node/GroveBME280I2C0/altitude -> float altitude"
"GET /v1/node/GroveBME280I2C0/pressure -> uint32_t pressure"
GroveSound "GET /v1/node/GroveSoundA0/sound_level -> int sound_level"
GroveSI114X "GET /v1/node/GroveSI114XI2C0/visiblelight -> float VL"
"GET /v1/node/GroveSI114XI2C0/IR -> float IR"
"GET /v1/node/GroveSI114XI2C0/UV -> float UV"
GroveSpeaker "POST /v1/node/GroveSpeakerD0/sound_stop"
"POST /v1/node/GroveSpeakerD0/sound_ms/{int freq}/{int duration_ms}"
"POST /v1/node/GroveSpeakerD0/sound_start/{int freq}"
GroveTemp "GET /v1/node/GroveTempA0/temp -> float temperature"
GroveTempHumPro "GET /v1/node/GroveTempHumProD1/humidity -> float humidity"
"GET /v1/node/GroveTempHumProD1/temperature -> float celsius_degree"
"GET /v1/node/GroveTempHumProD1/temperature_f -> float fahrenheit_degree"
GroveTempHum "GET /v1/node/GroveTempHumD0/humidity -> float humidity"
"GET /v1/node/GroveTempHumD0/temperature -> float celsius_degree"
"GET /v1/node/GroveTempHumD0/temperature_f -> float fahrenheit_degree"
GroveUltraRanger "GET /v1/node/GroveUltraRangerD0/range_in_inch -> float range_inch"
"GET /v1/node/GroveUltraRangerD0/range_in_cm -> float range_cm"
GroveUV "GET /v1/node/GroveUVA0/uv_index -> float uv_index"
GroveCompass "GET /v1/node/GroveCompassI2C0/compass_heading -> float heading_deg"
GroveGyroITG3200 "GET /v1/node/GroveGyroITG3200I2C0/temperature -> float temp"
"GET /v1/node/GroveGyroITG3200I2C0/gyro -> float gx, float gy, float gz"
"POST /v1/node/GroveGyroITG3200I2C0/zerocalibrate"
GroveAccMMA7660 "GET /v1/node/GroveAccMMA7660I2C0/acceleration -> float ax, float ay, float az"
"GET /v1/node/GroveAccMMA7660I2C0/shaked -> uint8_t shaked"
Grove4Digit "POST /v1/node/Grove4DigitUART0/display_point/{uint8_t display}"
"POST /v1/node/Grove4DigitUART0/display_digits/{uint8_t start_pos}/{char *chars}"
"POST /v1/node/Grove4DigitUART0/clear"
"POST /v1/node/Grove4DigitUART0/display_one_digit/{uint8_t position}/{char *chr}"
"POST /v1/node/Grove4DigitUART0/brightness/{uint8_t brightness}"
GroveLedWs2812 "POST /v1/node/GroveLedWs2812D0/clear/{uint8_t total_led_cnt}/{char *rgb_hex_string}"
"POST /v1/node/GroveLedWs2812D0/segment/{uint8_t start}/{char *rgb_hex_string}"
"POST /v1/node/GroveLedWs2812D0/start_rainbow_flow/{uint8_t length}/{uint8_t brightness}/{uint8_t speed}"
"POST /v1/node/GroveLedWs2812D0/stop_rainbow_flow"
GroveVolDivider "GET /v1/node/GroveVolDividerA0/voltage_x3 -> float volt"
"GET /v1/node/GroveVolDividerA0/voltage_x10 -> float volt"

All built-in event APIs

APIs
"Event GroveButtonD0 button_pressed"
"Event GenericDInD0 input_changed"
"Event GenericDInD0 input_rise"
"Event GenericDInD0 input_fall"
"Event GroveEncoderUART0 encoder_position"
"Event GroveUARTUART0 uart_rx"
"Event GroveIRRecvD0 ir_recv_data_hex"
"Event GroveIRRecvD0 ir_recv_data_len"
"Event GroveGestureI2C0 gesture"
"Event GroveIRDistanceInterrupterD1 ir_approached"
"Event GroveIRRecvD0 ir_recv_data_hex"
"Event GroveIRRecvD0 ir_recv_data_len"
"Event GroveMagneticSwitchD0 mag_approached"
"Event GrovePIRMotionD0 ir_moved"