The SmartSDK is a software development kit that allow developers to create applications that utilze the functions of Ricoh MFPs, via a WebAPI. There are three types of applications that can be created by using the Ricoh SmartSDK and they are described below:
SmartOperation Panel applications
A SmartOperation Panel application displays GUI on the SmartOperation Panel of an MFP.
Web Browser NX applications
A Web Browser NX application runs on the Web Browser NX installed on SmartOperation Panel.
Remote applications
A remote application runs on an external device connected to an MFP (e.g. a computer connected to the MFP).
The programming languages that a developer can use to develop on the Ricoh SmartSDK differ by the application type.
SmartOperation Panel applications: Java (Android API Level 10 compliant)
Web Browser NX applications: HTML, CSS, JavaScript (based on the Android 2.3.4 Webkit engine)
Remote applications: The languages that can use HTTP (e.g. JavaScript, Perl, Ruby)
At a high level the capabilities of the Ricoh SmartSDK are as follows:
Supported MFP functions: Copier, Printer, Scanner, Fax
Device management: Manage device states, obtain counter values, obtain device information, obtain logs, manage address book
Authentication controls (for SmartOperation Panel applications only): Customize authentication screens and authentication processes
Operation panel controls (for SmartOperation Panel applications only): Display screens, control beeper, control LED, etc.
The following describes the characteristics of SmartSDK.
Web API in REST-JSON format: APIs can be called on any device that can use HTTP; the APIs can be used on servers, computers, and smart devices.
Simple API calls: A copy/printer/scan/fax job can be started by the following three steps:
1. Obtain job condition availability
2. Set parameters
3. Create a job
Enhanced SmartOperation Panel application development environment: A developer can customize a sample application that is available in the Resource CD to create a new application smoothly and quickly. When an application is created, the developer can check operations using emulator and fully test the overall solution on a Ricoh device that supports the Ricoh SmartSDK.
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.
- SDKService - SDKService provides the APIs of the devices and the system controls that can be used only from SmartOperation Panel applications. The service cannot be used from remote applications. Details are described in the Developer’s Guide 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.