2.0.0 • Published 5 months ago

@dlenroc/roku-debug-server v2.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

@dlenroc/roku-debug-server · NPM Version

Client for host utilities provided via telnet on port 8080

Installation

npm install @dlenroc/roku-debug-server

Usage

import { DebugServerExecutor, getPlugins } from '@dlenroc/roku-debug-server';

const ctx = new DebugServerExecutor({
  hostname: '<ip>',
  port: 8080,
});

// typed
const plugins = await getPlugins(ctx);
console.log(plugins);

// raw
const rawResult = await ctx.execute('plugins');
console.log(rawResult);

MethodCommandDescription
clearLaunchCachesclear_launch_cachesClear all caches that can affect channel launch time
clearSceneGraphPerformanceMetrics getSceneGraphPerformanceMetrics startSceneGraphPerformanceTracking stopSceneGraphPerformanceTrackingsgperfSceneGraph node operation performance metrics
disableRendezvousLogging enableRendezvousLogging getRendezvousLoggingStatuslogrendezvousTurn Rendezvous Logging on or off
generateDeveloperKeygenkeyGenerate a new developer key
getChannelPerformanceStats scheduleChannelPerformanceLoggingchanperfShow channel CPU and memory usage
getDeveloperKeyshowkeyShow the current developer key
getLoadedTexturesloaded_texturesShow loaded textures (default main RenderContext)
getMaxWarningCount setMaxWarningCountbrightscript_warningsSet the maximum number of brightscript warnings displayed
getMemoryStatsfreeReturn the output of the free(1) command
getPluginspluginsShow list of all installed plugins
getProfilingStatusbsprof-statusGet BS profiling status
getR2D2Bitmapsr2d2_bitmapsEnumerate R2D2 bitmaps
getSceneGraphNodessgnodesList Scene Graph nodes
hideFPS showFPS toggleFPSfps_displayDisplay onscreen graphics statistics
pauseProfilingbsprof-pausePause BS profiling
presspressSimulate a keypress
removePluginremove_pluginRemove a plugin from the account and device
resumeProfilingbsprof-resumeResume BS profiling
typetypeSend a literal text sequence