design. develop. deploy.

Ricoh SmartSDK Details

Overview

The SmartSDK is a software development kit that allow developers to create applications that utilize and extend the functions of Ricoh multi-function devices. There are three types of applications that can be created by using the Ricoh SmartSDK and they are described below:

  1. SmartOperation Panel applications
    • A SmartOperation Panel application displays GUI on the SmartOperation Panel of an MFP
    • Solutions are created using almost any JVM language (Java, Kotlin, etc.) suitable for Android development
  2. Web Browser NX applications
    • A Web Browser NX application runs on the Web Browser NX installed on SmartOperation Panel
    • solutions are created with HTML, CSS, JavaScript (based on the Blink or Webkit engines, depending on the model)
  3. Remote applications
    • A remote application runs on an external device connected to an MFP (e.g. a computer connected to the MFP)
    • Solutions are created with any language or framework suitable for HTTP based development (e.g. JavaScript, Perl, Ruby)

See SmartSDK Components, below.

SmartSDK Capabilities

At a high level the capabilities of the Ricoh SmartSDK are as follows:

  1. Supported MFP functions
    • e.g., Copier, Printer, Scanner, Fax
  2. Device management
    • e.g., Manage device states, obtain counter values, obtain device information, obtain logs, manage address book
  3. Authentication controls (for SmartOperation Panel applications only)
    •   Customize authentication screens and authentication processes
  4. Operation panel controls (for SmartOperation Panel applications only)
    •   Display screens, control beeper, control LED, etc.

SmartSDK Components

The Ricoh SmartSDK consists of the following components:

  • Web API
    • ​​​​​​​MFP functions are provided as web APIs. Details of each function are provided in the API specification document for the function
    • A simple RESTful JSON (or XML) based API can be accessed by any device that uses HTTP
    • Suitable for for local application, server, and smart device access
  • SDKService 
    • SDKService provides the APIs of the devices and the system controls that can be used only from SmartOperation Panel applications
    • This service cannot be used from remote applications
    • Details are described in the development kit documents
  • Web Browser NX 
    • JavaScript library and SmartSDK JavaScript library, SmartSDK Application JS
  • Android Framework
    • ​​​​​​​This module is the Android SDK development library
    • This module is not provided by Ricoh
    • Where Ricoh devices diverge from standard Android frameworks is described in the development kit documentation
  • Other Frameworks
    • ​​​​​​​Ricoh supplied optional and third-party frameworks can be used to extend functionality

SmartSDK Development Environment

  • Full SmartSDK API documentation that discusses capabilities, functions, limitations, and components
  • Sample applications ready for rapid application development
  • SmartSDK emulator, similar to Android emulation for faster development
    • Final testing on a Ricoh device is recommended before compatibility testing