Naming conventions

Naming conventions followed

  • No third party calls will be made directly. Everything will pass through a RS wrapper.

  • Small letters for folder/file names

For APIs

  • Must begin with rs_, followed by module name (i2c, ring_buf) followed by operation verb (write, delete, push).

rs_ring_buf_push ();
rs_i2c_write ();

For HAL Calls

  • Must begin with rs_hal_, followed by module name (i2c, ring_buf) followed by operation verb (write, delete, push).

rs_hal_i2c_write ();

For Callbacks

  • Must begin with rcb_, followed by module name (i2c, ring_buf) followed by operation actions (written, deletion, pushed).

rcb_i2c_data_written ();

Ensure the same is followed for uniform coding.