akari-grpc-client

library0.1.1jsnpmunverified

A Node.js gRPC client for Akari robotic systems, ported from the official Python akari_client. Version 0.1.1 is the initial release with no active development cadence. It provides an object-oriented API to control servo joints and M5Stack displays over gRPC. Unlike the Python SDK, this package uses protocol buffers generated with grpc-tools and supports TypeScript natively. It is intended for use with physical Akari robots or simulators that expose a gRPC endpoint.

robotics

npm install akari-grpc-client

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · AKARI-GRPC-CLIENT

akari-grpc-client

roboticsjavascriptv0.1.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

AkariGrpcClient

✓ import { AkariGrpcClient } from 'akari-grpc-client'

✗ const AkariGrpcClient = require('akari-grpc-client')

Package is ESM-only with TypeScript types.

m5stack

✓ import m5stack from 'akari-grpc-client/dist/akari_proto/m5stack_pb.js'

✗ import m5stack from 'akari-grpc-client/akari_proto/m5stack_pb'

Proto-generated modules are in the dist/ directory; do not omit 'dist' or extension.

joints

✓ await akari.joints.enableAllServo()

✗ akari.joints.enableAllServo()

All operations are async; must use await.

Creates an AkariGrpcClient, enables all servos, moves pan/tilt joints, waits one second, then reads current positions.

import { AkariGrpcClient } from 'akari-grpc-client'; const akari = new AkariGrpcClient(); await akari.joints.enableAllServo(); await akari.joints.moveJointPositions({ pan: 0.5, tilt: 0.3 }); await new Promise(resolve => setTimeout(resolve, 1000)); console.log(await akari.joints.getJointPositions());

Debug

Known issues

gotchaAll methods are async; forgetting await will hang the script silently.

fix

Always use await when calling client methods.

affects: >=0.1

gotchaProto imports require explicit path to dist/akari_proto/*.js, not a bare module specifier.

fix

Use 'akari-grpc-client/dist/akari_proto/m5stack_pb.js' instead of 'akari-grpc-client/m5stack_pb'.

affects: >=0.1

gotchaPackage ships TypeScript types but no source maps; debugging may be harder in TypeScript node environments.

fix

Use ts-node with sourceMap support or compile with --sourceMap.

affects: >=0.1

Errors

Common errors & fixes

Error: Cannot find module 'akari-grpc-client'

Package not installed or import path incorrect.

fix

Run 'npm install akari-grpc-client' and use correct import: 'import { AkariGrpcClient } from "akari-grpc-client"'.

TypeError: akari.joints.enableAllServo is not a function

Client not initialized or imported incorrectly, or forgot to await construction.

fix

Ensure 'const akari = new AkariGrpcClient()' is awaited if it returns a promise (it doesn't, but all methods are async). Check import is from 'akari-grpc-client'.

Error: 14 UNAVAILABLE: failed to connect to all addresses

No gRPC server running at default address (localhost:50051).

fix

Start the Akari robot simulator or robot, or set custom endpoint via constructor options.

Upgrade

Version history

0.1.1latest on npm

Audit

Dependencies

@grpc/grpc-jsrequiredRuntime gRPC implementation

Agent activity

34 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/uboar/akari-grpc-client ↗

packageakari-grpc-client ↗

homepagehttps://github.com/uboar/akari-grpc-client#readme ↗