Class UtilClass

Example

Copy

Example

• Perform actions following UDS initialization using a normal function.

  Util.Init(()=>{
    console.log('Hello UDS!')
  })
  Copy

• Perform actions following UDS initialization using an async function.

  Util.Init(async ()=>{
    const file=await fs.readFile(path.join(process.env.PROJECT_ROOT,'file.bin'))
    let length=file.length
    console.log('Hello UDS file! file length is', length)
  })
  Copy

• The last registered function will override the previous ones.

  // The following code will be ignored
  Util.Init(async ()=>{
      console.log('1')
  })
  
  // The following code will take effect
  Util.Init(async ()=>{
      console.log('2')
  })
  Copy

Example

Util.On('Can.testService.send', ()=>{
    console.log('this function will not be Off')
})

Util.Off('Can.testService.send', ()=>{
    console.log('this function will not be Off')
})

Copy

Example

// Define a callback function
const rpmCallback = ({ rawValue, physValue }) => {
  console.log(`RPM: ${physValue}`)
}

// Register the listener
OnSignal("Engine.EngineRPM", rpmCallback)

// Later, remove the listener
OffSignal("Engine.EngineRPM", rpmCallback)

// Anonymous functions cannot be removed easily, so use named functions:
// ❌ This won't work for removal:
// OnSignal("Engine.RPM", ({ physValue }) => console.log(physValue))

// ✅ This will work for removal:
const callback = ({ physValue }) => console.log(physValue)
OnSignal("Engine.RPM", callback)
OffSignal("Engine.RPM", callback)
Copy

Example

const handler = (msg) => console.log(msg);

// Unsubscribe from all SOMEIP messages
Util.OffSomeipMessage(true, handler);

// Unsubscribe from specific service/instance/method
Util.OffSomeipMessage('1234.5678.90ab', handler);
Copy

Example

The UDS is a UDSClass type and has already been created by Service.

1. send functions

   Util.On('Can.testService.send', async (req) => {
      // The req is a `DiagRequest`
      console.log(req.getServiceName(), ': send');
   });
   Copy

2. recv function

   Util.On('Can.testService.recv', async (req) => {
      // The req is a `DiagResponse`
      console.log(req.getServiceName(), ':recv');
   });
   Copy

Example

Util.OnOnce('Can.testService.send', async (req) => {
   // The req is a `DiagRequest`
   console.log(req.getServiceName(), ': send once');
});
Copy

Example

// Listen for engine RPM signal updates
OnSignal("Engine.EngineRPM", ({ rawValue, physValue }) => {
  console.log(`Engine RPM: ${physValue} (raw: ${rawValue})`)
})

// Listen for gear position signal with enum values
OnSignal("Transmission.GearPosition", ({ rawValue, physValue }) => {
  console.log(`Gear: ${physValue}`) // Could be "Park", "Drive", "Reverse", etc.
})

// Async callback example
OnSignal("Battery.Voltage", async ({ rawValue, physValue }) => {
  if (physValue < 12.0) {
    await sendWarning("Low battery voltage detected!")
  }
})
Copy

Example

// Wait for the first engine start signal
OnSignalOnce("Engine.EngineStatus", ({ rawValue, physValue }) => {
  if (physValue === "Running") {
    console.log("Engine started successfully!")
  }
})

// Wait for initialization complete signal
OnSignalOnce("System.InitStatus", async ({ rawValue, physValue }) => {
  if (physValue === "Complete") {
    await startDiagnosticSequence()
  }
})
Copy

Example

// Listen for all SOMEIP messages
Util.OnSomeipMessage(true, (msg) => {
  console.log('Received SOMEIP message:', msg);
});

// Listen for specific service/instance/method
Util.OnSomeipMessage('0034.5678.90ab', (msg) => {
  console.log('Received specific SOMEIP message:', msg);
});

// Listen for specific service/wildcard
Util.OnSomeipMessage('0034.*.*', (msg) => {
  console.log('Received specific SOMEIP message:', msg);
});
Copy

Example

// Listen once for any SOMEIP message
Util.OnSomeipMessageOnce(true, (msg) => {
  console.log('Received one SOMEIP message:', msg);
});

// Listen once for specific service/instance/method
Util.OnSomeipMessageOnce('1234.5678.90ab', (msg) => {
  console.log('Received one specific SOMEIP message:', msg);
});
Copy

Example

// Listen for updates to a specific variable
Util.OnVar('temperature', ({name, value}) => {
  console.log(`${name} changed to ${value}`);
});

// Listen for all variable updates using wildcard
Util.OnVar('*', ({name, value}) => {
  console.log(`Variable ${name} updated to ${value}`);
});
Copy

Example

Util.Register('Can.testJob', async (v) => {

    const testService = new DiagRequest();
    const newData = Buffer.from([0x10, 0x01, 0x00, 0x01, 0x02]);
    await testService.diagSetRaw(newData);
    return [testService];
});
Copy