Local instructions¶

SolarNode provides the net.solarnetwork.node.reactor.InstructionExecutionService API for plugins that want to issue local instructions within SolarNode itself.

InstructionExecutionService APIExample Blueprint XML

public interface InstructionExecutionService {

    /**
     * Execute a single instruction.
     *
     * @param instruction
     *        the instruction to execute
     * @return the resulting status for the instruction, or {@code null} if not
     *         handled
     */
    @Nullable
    InstructionStatus executeInstruction(Instruction instruction);

}

<!-- reference as an OptionalService like this: -->
<bean id="instructionExecutionService"
        class="net.solarnetwork.common.osgi.service.DynamicServiceTracker">
    <argument ref="bundleContext"/>
    <property name="serviceClassName"
        value="net.solarnetwork.node.reactor.InstructionExecutionService"/>
    <property name="sticky" value="true"/>
</bean>


<!-- or as a direct reference like this: -->
<reference id="instructionExecutionService"
    interface="net.solarnetwork.node.reactor.InstructionExecutionService"/>

The net.solarnetwork.node.reactor.InstructionUtils class provides some createLocalInstruction() helper methods for creating Instruction instances, which you then pass to the executeInstruction() method.

Note

Note that local instructions submitted to the executeInstruction() method are processed immediately, not asyncronously like external instructions.

Create a local instruction example

// use the SetControlParameter instruction to update a runtime control value
double desiredControlValue = calculateControlValue();
InstructionExecutionService instrService = OptionalService.service(instructionExecutionService);
Instruction instr = InstructionUtils.createLocalInstruction(
        InstructionHandler.TOPIC_SET_CONTROL_PARAMETER,
        "/setpoint/1",
        String.valueOf(desiredControlValue));
InstructionStatus instrResult;
if ( instrService != null ) {
    instrResult = instrService.executeInstruction(instr);
} else {
    instrResult = createStatus(instr, InstructionState.Declined, Map.of(
            InstructionHandler.PARAM_MESSAGE,
            "No InstructionExecutionService available."));
}
// do something with the result here